# Welcome 👋 ## Docs - [Get contacts by status](https://docs.vambe.me/api-reference/analytics/get-contacts-by-status.md): Returns contacts filtered by status and calculates how long they have been waiting (from last_inbound_message.created_at until now). Adds a "waiting_time" field that represents (in seconds) how long that contact has been waiting. Sorted by waiting_time descending (longest wait first). - [Create a new folder](https://docs.vambe.me/api-reference/assistant-documents/create-a-new-folder.md): Create a new knowledge base folder to organize documents. - [Delete a document from a given assistant](https://docs.vambe.me/api-reference/assistant-documents/delete-a-document-from-a-given-assistant.md): Delete a document from a given assistant. - [Get all folders](https://docs.vambe.me/api-reference/assistant-documents/get-all-folders.md): Retrieve all knowledge base folders for your organization. - [Upload a raw document to a given assistant](https://docs.vambe.me/api-reference/assistant-documents/upload-a-raw-document-to-a-given-assistant.md): Upload a raw document to a given assistant. - [Get campaigns](https://docs.vambe.me/api-reference/campaigns/get-campaigns.md): Get campaigns for the user - [Get contacts send in a campaign](https://docs.vambe.me/api-reference/campaigns/get-contacts-send-in-a-campaign.md): Get the contacts that were sent in a campaign - [Create tags for a contact](https://docs.vambe.me/api-reference/channels/create-tags-for-a-contact.md): Creates tags for the contact for the specified channel. TICKET-type tags are only assigned when the contact has an active ticket. The response reports counts for created, assigned, and not-assigned tags, plus details explaining why some could not be assigned. - [Retrieve channel by type](https://docs.vambe.me/api-reference/channels/retrieve-channel-by-type.md): Fetches the channel associated with the specified channel type for the authenticated user. - [Assign an team member to an AI contact](https://docs.vambe.me/api-reference/contact/assign-an-team-member-to-an-ai-contact.md) - [Get all tags for an AI contact](https://docs.vambe.me/api-reference/contact/get-all-tags-for-an-ai-contact.md): Retrieve all tags configured for your organization. Use the tag IDs for updating contact tags. - [Get contacts by days](https://docs.vambe.me/api-reference/contact/get-contacts-by-days.md): Retrieve contacts that had their last message within the specified number of days. Works across all channels (WhatsApp, Instagram, etc.). Optionally filter by custom field values. - [Get info of an AI contact](https://docs.vambe.me/api-reference/contact/get-info-of-an-ai-contact.md) - [Retrieve conversations by AI contact](https://docs.vambe.me/api-reference/contact/retrieve-conversations-by-ai-contact.md) - [Retrieve info by channel identifier](https://docs.vambe.me/api-reference/contact/retrieve-info-by-channel-identifier.md): Replaces the old endpoint /public/ai-message/whatsapp/:channelIdentifier/info - [Retrieve messages by AI contact](https://docs.vambe.me/api-reference/contact/retrieve-messages-by-ai-contact.md): Replaces the old endpoint /public/ai-message/:aiContactId - [Retrieve messages by AI contact with pagination](https://docs.vambe.me/api-reference/contact/retrieve-messages-by-ai-contact-with-pagination.md): Replaces the old endpoint /public/ai-message/:aiContactId - [Retrieve messages by conversation](https://docs.vambe.me/api-reference/contact/retrieve-messages-by-conversation.md): Replaces the old endpoint /public/ai-message/whatsapp/:channelIdentifier - [Search contacts by phone or email](https://docs.vambe.me/api-reference/contact/search-contacts-by-phone-or-email.md): Find contacts by phone number or email address. Searches across all channels. At least one search parameter is required. - [Update all the tags from an AI contact](https://docs.vambe.me/api-reference/contact/update-all-the-tags-from-an-ai-contact.md) - [Update metadata to an AI contact](https://docs.vambe.me/api-reference/contact/update-metadata-to-an-ai-contact.md) - [Upsert a contact](https://docs.vambe.me/api-reference/customer/upsert-a-contact.md): Creates or finds an existing contact for whatsapp, web-whatsapp, or webchat channels. For whatsapp/web-whatsapp, the contact is identified by phone number. For webchat, the contact is identified by external_user_id. Optionally assigns an agent, updates metadata, sets a stage, and upserts custom fiel… - [Get apipublicbooking url](https://docs.vambe.me/api-reference/get-apipublicbooking-url.md) - [Get apipublicbooking url availabilities](https://docs.vambe.me/api-reference/get-apipublicbooking-url-availabilities.md) - [Get apipublicbooking url availabilitiesprofessionaltreatment](https://docs.vambe.me/api-reference/get-apipublicbooking-url-availabilitiesprofessionaltreatment.md) - [Get apipublicbooking url availabilitiestreatmentlocation](https://docs.vambe.me/api-reference/get-apipublicbooking-url-availabilitiestreatmentlocation.md) - [Get apipublicbooking url professionals](https://docs.vambe.me/api-reference/get-apipublicbooking-url-professionals.md) - [Get apipublicbooking url treatments](https://docs.vambe.me/api-reference/get-apipublicbooking-url-treatments.md) - [Get apitext classifier random](https://docs.vambe.me/api-reference/get-apitext-classifier-random.md) - [Get apipublicorder product](https://docs.vambe.me/api-reference/order/get-apipublicorder-product.md) - [Post apipublicai customermerge customersby ai contact](https://docs.vambe.me/api-reference/post-apipublicai-customermerge-customersby-ai-contact.md) - [Post apipublicbooking url create appointment](https://docs.vambe.me/api-reference/post-apipublicbooking-url-create-appointment.md) - [Post apipublicbooking url patients](https://docs.vambe.me/api-reference/post-apipublicbooking-url-patients.md) - [Post apitext classifier label](https://docs.vambe.me/api-reference/post-apitext-classifier-label.md) - [Post apitext classifier train](https://docs.vambe.me/api-reference/post-apitext-classifier-train.md) - [Post apiunipileaccountlink](https://docs.vambe.me/api-reference/post-apiunipileaccountlink.md) - [Post apiunipileaccountwebhook](https://docs.vambe.me/api-reference/post-apiunipileaccountwebhook.md) - [Post apiunipilechatstart](https://docs.vambe.me/api-reference/post-apiunipilechatstart.md) - [Post apiunipilemessagesend](https://docs.vambe.me/api-reference/post-apiunipilemessagesend.md) - [Post apiunipilemessagewebhook](https://docs.vambe.me/api-reference/post-apiunipilemessagewebhook.md) - [Create products](https://docs.vambe.me/api-reference/product/create-products.md): Create and update products without deleting existing ones. This endpoint only creates new products and updates existing ones. - [Delete products](https://docs.vambe.me/api-reference/product/delete-products.md): Delete products by their external IDs. This endpoint only deletes products. - [Get product blocks to upsert products](https://docs.vambe.me/api-reference/product/get-product-blocks-to-upsert-products.md): Get product blocks to upsert products - [Upsert products](https://docs.vambe.me/api-reference/product/upsert-products.md): Upsert products and their embeddings, this endpoint creates and updates all products that are in the list and delete all products that are not in the list. - [Get event metrics by event key](https://docs.vambe.me/api-reference/public-event-metrics/get-event-metrics-by-event-key.md): Retrieve analytics and metrics for a specific event key - [Get URL tracking metrics](https://docs.vambe.me/api-reference/public-event-metrics/get-url-tracking-metrics.md): Retrieve metrics for events that contain specific URL patterns - [Get event by key](https://docs.vambe.me/api-reference/public-events/get-event-by-key.md): Retrieve event information by event key and client - [Get event instance by ID](https://docs.vambe.me/api-reference/public-events/get-event-instance-by-id.md): Retrieve a specific event instance by ID and client - [Get event instances by event key](https://docs.vambe.me/api-reference/public-events/get-event-instances-by-event-key.md): Retrieve event instances for a specific event key and client - [Get Pipelines](https://docs.vambe.me/api-reference/publicpipeline/get-pipelines.md): Retrieve pipelines based on the provided user. - [Send a message](https://docs.vambe.me/api-reference/publicweb-whatsapp-message/send-a-message.md): Send a specific message to a given phone number. - [Get all tags](https://docs.vambe.me/api-reference/tags/get-all-tags.md): Retrieve all tags configured for your organization. Use the tag IDs for updating contact tags. - [Create a new task](https://docs.vambe.me/api-reference/tasks/create-a-new-task.md): Creates a new task for the authenticated user. The task can be associated with a contact or customer, and assigned to one or more responsible users. Due dates can be specified with optional time and timezone information. - [Delete a task](https://docs.vambe.me/api-reference/tasks/delete-a-task.md): Soft deletes a task by ID. The task will be marked as deleted but not permanently removed from the database. Associated interactive notes will also be deleted. - [Get tasks](https://docs.vambe.me/api-reference/tasks/get-tasks.md): Retrieves all tasks based on query parameters. Filters can include responsible user IDs and date range (fromDate/toDate). - [Update an existing task](https://docs.vambe.me/api-reference/tasks/update-an-existing-task.md): Updates an existing task by ID. Only the fields provided in the request body will be updated. All fields are optional for updates. - [Get average first response time](https://docs.vambe.me/api-reference/team-analytics/get-average-first-response-time.md): Returns the average time of the first response per contact within the specified date range - [Get detailed unanswered conversations](https://docs.vambe.me/api-reference/team-analytics/get-detailed-unanswered-conversations.md): Returns detailed information about open conversations without responses for the authenticated user's organization - [Get pipeline distribution of open conversations](https://docs.vambe.me/api-reference/team-analytics/get-pipeline-distribution-of-open-conversations.md): Returns the distribution of open conversations across different pipelines - [Get response-time statistics](https://docs.vambe.me/api-reference/team-analytics/get-response-time-statistics.md): Returns median, p90 and average waiting time (in minutes) for answered messages - [Get team member distribution of open conversations](https://docs.vambe.me/api-reference/team-analytics/get-team-member-distribution-of-open-conversations.md): Returns the distribution of open conversations across different agents with average waiting time - [Get unanswered conversations count](https://docs.vambe.me/api-reference/team-analytics/get-unanswered-conversations-count.md): Returns the count of open conversations without responses for the authenticated user's organization - [Get all team members](https://docs.vambe.me/api-reference/team-members/get-all-team-members.md) - [Get templates](https://docs.vambe.me/api-reference/templates/get-templates.md): Retrieve templates based on the provided query parameters. - [List ticket feedbacks](https://docs.vambe.me/api-reference/ticket-feedback/list-ticket-feedbacks.md): Retrieve paginated ticket feedback records with optional filtering by type, date range, pipeline, and response status. - [Close a ticket](https://docs.vambe.me/api-reference/ticket/close-a-ticket.md) - [Open a new ticket for web whatsapp](https://docs.vambe.me/api-reference/ticket/open-a-new-ticket-for-web-whatsapp.md) - [Open a new ticket for whatsapp](https://docs.vambe.me/api-reference/ticket/open-a-new-ticket-for-whatsapp.md) - [Update metadata of a ticket](https://docs.vambe.me/api-reference/ticket/update-metadata-of-a-ticket.md): Updates metadata of the active ticket, or the latest closed ticket if allow_closed_ticket is true. - [Full-text search](https://docs.vambe.me/api-reference/turbopuffer/full-text-search.md): Performs BM25 full-text search. - [Hybrid search](https://docs.vambe.me/api-reference/turbopuffer/hybrid-search.md): Performs a hybrid search combining vector similarity and BM25 text matching using Reciprocal Rank Fusion. - [Vector search](https://docs.vambe.me/api-reference/turbopuffer/vector-search.md): Performs k-NN vector similarity search. - [Create custom UTM event](https://docs.vambe.me/api-reference/utm-events/create-custom-utm-event.md): Queues a custom UTM event with user-defined fields. Only ai_contact_id is required; all other fields are optional. Accepts arbitrary JSON in additional_params. - [Add metadata for a webchat contact](https://docs.vambe.me/api-reference/webchat-contact/add-metadata-for-a-webchat-contact.md): Add metadata for a webchat contact - [Create a new webhook](https://docs.vambe.me/api-reference/webhooks/create-a-new-webhook.md) - [Delete a webhook](https://docs.vambe.me/api-reference/webhooks/delete-a-webhook.md) - [Get a webhook by ID](https://docs.vambe.me/api-reference/webhooks/get-a-webhook-by-id.md) - [Get all available webhook topics](https://docs.vambe.me/api-reference/webhooks/get-all-available-webhook-topics.md) - [Get all webhooks for the authenticated user](https://docs.vambe.me/api-reference/webhooks/get-all-webhooks-for-the-authenticated-user.md) - [Get webhook call history](https://docs.vambe.me/api-reference/webhooks/get-webhook-call-history.md) - [Restore a soft-deleted webhook](https://docs.vambe.me/api-reference/webhooks/restore-a-soft-deleted-webhook.md) - [Update a webhook](https://docs.vambe.me/api-reference/webhooks/update-a-webhook.md) - [Get contacts](https://docs.vambe.me/api-reference/whatsapp-contact/get-contacts.md): Get the contacts where the last message was in the last X days - [Cancel a programmed message by scheduled message Id](https://docs.vambe.me/api-reference/whatsapp-message/cancel-a-programmed-message-by-scheduled-message-id.md): Cancel a already programmed message. If the message is canceled or in the past the operation will do nothing - [Send a note message](https://docs.vambe.me/api-reference/whatsapp-message/send-a-note-message.md): Send a note message to a given phone number. - [Send a program a template message to send at a specific time](https://docs.vambe.me/api-reference/whatsapp-message/send-a-program-a-template-message-to-send-at-a-specific-time.md): Send a specific template message to a given phone number at a given time. - [Send a template message](https://docs.vambe.me/api-reference/whatsapp-message/send-a-template-message.md): Send a specific template message to a given phone number. - [Send a template message](https://docs.vambe.me/api-reference/whatsapp-message/send-a-template-message-1.md): Send a specific template message to a given phone number. - [Send a template message with unstructured data](https://docs.vambe.me/api-reference/whatsapp-message/send-a-template-message-with-unstructured-data.md): Send a specific template message to a given phone number. Don't worry about the structure, if the data is in the body AI will take care of it - [Send a template message with unstructured data](https://docs.vambe.me/api-reference/whatsapp-message/send-a-template-message-with-unstructured-data-1.md): Send a specific template message to a given phone number. Don't worry about the structure, if the data is in the body AI will take care of it - [Connect your first channel](https://docs.vambe.me/docs/connect-channel.md): Set up WhatsApp, Instagram, Webchat, or Messenger to start receiving customer messages in Vambe. - [Connect WhatsApp Business API](https://docs.vambe.me/docs/connect-whatsapp-api.md): Set up official Meta WhatsApp Business API integration with Vambe for scalable messaging. - [Connect WhatsApp QR](https://docs.vambe.me/docs/connect-whatsapp-qr.md): Quick setup guide to connect your personal or business WhatsApp using QR code scanning. - [Create your first pipeline](https://docs.vambe.me/docs/create-pipeline.md): Learn how to build a sales funnel with AI assistants and human agents using Vambe Mercur. - [Create your first template](https://docs.vambe.me/docs/create-template.md): Design and submit WhatsApp message templates for approval to send notifications, confirmations, and marketing messages. - [E-commerce Integration Guide](https://docs.vambe.me/docs/ecommerce-guide.md): Learn how to integrate your product catalog with Vambe AI assistants. Manage products, sync inventory, and enable AI-powered product recommendations. - [Quickstart](https://docs.vambe.me/docs/quickstart.md): Get started with Vambe: account setup, channels, API keys, and your first request. - [Send QR message](https://docs.vambe.me/docs/send-qr-message.md): Learn how to send WhatsApp messages through your QR-connected number using Vambe API. - [Send a template message](https://docs.vambe.me/docs/send-template-message.md): Learn how to send WhatsApp template messages via Vambe API for notifications, confirmations, and marketing campaigns. - [Webchat Integration Guide](https://docs.vambe.me/docs/webchat-integration.md): Learn how to integrate Vambe Webchat into your website. Add AI-powered customer support directly to your web pages in minutes. - [Webhooks](https://docs.vambe.me/docs/webhooks.md): Set up real-time notifications for events in your Vambe account using webhooks. Get notified instantly when messages are received, tickets are created, or pipeline stages change. - [Get team member distribution of open conversations](https://docs.vambe.me/reference/analytics/get-agent-distribution.md): Returns the distribution of open conversations across different agents with average waiting time - [Get average first response time](https://docs.vambe.me/reference/analytics/get-average-first-response-time.md): Returns the average time of the first response per contact within the specified date range - [Get contacts by status](https://docs.vambe.me/reference/analytics/get-contacts-by-status.md): Returns contacts filtered by status and calculates how long they have been waiting (from last_inbound_message.created_at until now). Adds a "waiting_time" field that represents (in seconds) how long that contact has been waiting. Sorted by waiting_time descending (longest wait first). - [Get detailed unanswered conversations](https://docs.vambe.me/reference/analytics/get-unanswered-conversations-details.md): Returns detailed information about open conversations without responses for the authenticated user's organization - [Create a new folder](https://docs.vambe.me/reference/assistant/create-folder.md): Create a new knowledge base folder to organize documents. - [Delete a document from a given assistant](https://docs.vambe.me/reference/assistant/delete-document.md): Delete a document from a given assistant. - [Get all folders](https://docs.vambe.me/reference/assistant/get-folders.md): Retrieve all knowledge base folders for your organization. - [Upload a raw document to a given assistant](https://docs.vambe.me/reference/assistant/upload-document.md): Upload a raw document to a given assistant. - [Get contacts by days](https://docs.vambe.me/reference/contact/get-contacts-by-days.md): Retrieve contacts that had their last message within the specified number of days. Works across all channels (WhatsApp, Instagram, etc.). Optionally filter by custom field values. - [Retrieve conversations by AI contact](https://docs.vambe.me/reference/contact/get-conversations.md) - [Get info of an AI contact](https://docs.vambe.me/reference/contact/get-info-of-an-ai-contact.md) - [Retrieve messages by AI contact with pagination](https://docs.vambe.me/reference/contact/get-messages-paginated.md): Replaces the old endpoint /public/ai-message/:aiContactId - [Search contacts by phone or email](https://docs.vambe.me/reference/contact/search-contacts.md): Find contacts by phone number or email address. Searches across all channels. At least one search parameter is required. - [Update metadata to an AI contact](https://docs.vambe.me/reference/contact/update-contact-metadata.md) - [Upsert a contact](https://docs.vambe.me/reference/customer/upsert-customer-info.md): Creates or finds an existing contact for whatsapp, web-whatsapp, or webchat channels. For whatsapp/web-whatsapp, the contact is identified by phone number. For webchat, the contact is identified by external_user_id. Optionally assigns an agent, updates metadata, sets a stage, and upserts custom fiel… - [Create products](https://docs.vambe.me/reference/product/create-products.md): Create and update products without deleting existing ones. This endpoint only creates new products and updates existing ones. - [Delete products](https://docs.vambe.me/reference/product/delete-products.md): Delete products by their external IDs. This endpoint only deletes products. - [Get order products](https://docs.vambe.me/reference/product/get-order-products.md) - [Get product blocks to upsert products](https://docs.vambe.me/reference/product/get-product-blocks.md): Get product blocks to upsert products - [Upsert products](https://docs.vambe.me/reference/product/upsert-products.md): Upsert products and their embeddings, this endpoint creates and updates all products that are in the list and delete all products that are not in the list. - [Get Pipelines](https://docs.vambe.me/reference/publicpipeline/get-pipelines.md): Retrieve pipelines based on the provided user. - [Send Web WhatsApp Message (Unstructured)](https://docs.vambe.me/reference/publicweb-whatsapp-message/send-a-message.md): Send a Web WhatsApp message from a specific phoneId. Accepts JSON, multipart/form-data, or x-www-form-urlencoded. Important: include the end user's phone number (e.g., phone_number) or a resolvable contact identifier in the payload so the AI can identify the recipient. You may pass the message text… - [Create tags for a contact](https://docs.vambe.me/reference/tags/create-tags-by-channel.md): Creates tags for the contact for the specified channel. TICKET-type tags are only assigned when the contact has an active ticket. The response reports counts for created, assigned, and not-assigned tags, plus details explaining why some could not be assigned. - [Get all tags](https://docs.vambe.me/reference/tags/get-all-tags.md): Retrieve all tags configured for your organization. Use the tag IDs for updating contact tags. - [Update all the tags from an AI contact](https://docs.vambe.me/reference/tags/update-contact-tags.md) - [Create a new task](https://docs.vambe.me/reference/tasks/create-task.md): Creates a new task for the authenticated user. The task can be associated with a contact or customer, and assigned to one or more responsible users. Due dates can be specified with optional time and timezone information. - [Delete a task](https://docs.vambe.me/reference/tasks/delete-task.md): Soft deletes a task by ID. The task will be marked as deleted but not permanently removed from the database. Associated interactive notes will also be deleted. - [Get tasks](https://docs.vambe.me/reference/tasks/get-tasks.md): Retrieves all tasks based on query parameters. Filters can include responsible user IDs and date range (fromDate/toDate). - [Update an existing task](https://docs.vambe.me/reference/tasks/update-task.md): Updates an existing task by ID. Only the fields provided in the request body will be updated. All fields are optional for updates. - [Assign an team member to an AI contact](https://docs.vambe.me/reference/team-members/assign-team-member-to-contact.md) - [Get all team members](https://docs.vambe.me/reference/team-members/get-all-team-members.md) - [Open a new ticket for web whatsapp](https://docs.vambe.me/reference/ticket/open-ticket-web-whatsapp.md) - [Open a new ticket for whatsapp](https://docs.vambe.me/reference/ticket/open-ticket-whatsapp.md) - [Update metadata of a ticket](https://docs.vambe.me/reference/ticket/update-ticket-metadata.md): Updates metadata of the active ticket, or the latest closed ticket if allow_closed_ticket is true. - [Add metadata for a webchat contact](https://docs.vambe.me/reference/webchat/add-webchat-contact-metadata.md): Add metadata for a webchat contact - [Get WhatsApp Contacts (Deprecated)](https://docs.vambe.me/reference/whatsapp-contact/get-contacts.md): [DEPRECATED] Get WhatsApp contacts by days. Use GET /api/public/contacts instead for all channels. - [Cancel Scheduled WhatsApp Message](https://docs.vambe.me/reference/whatsapp-message/cancel-a-programmed-message-by-scheduled-message-id.md): Cancel a previously scheduled message by scheduleMessageId. Idempotent: does nothing if already canceled or scheduled time has passed. Requires x-api-key. - [Send WhatsApp Note Message (Deprecated)](https://docs.vambe.me/reference/whatsapp-message/send-a-note-message.md): [DEPRECATED] Send an internal note via WhatsApp to a specific contact. Use POST /api/public/ticket/open/web-whatsapp/{phoneId} instead. - [Schedule a WhatsApp Template Message](https://docs.vambe.me/reference/whatsapp-message/send-a-program-a-template-message-to-send-at-a-specific-time.md): Create a scheduled send for a WhatsApp template. Body includes templateId (uuid), contactIdentifier (phone), channel (whatsapp|web-whatsapp), scheduledDate (ISO 8601), optional content (variables for AI/smart), isSmart, fromPhoneNumber, stageId, and channelId. Requires x-api-key. - [Send WhatsApp Template by Phone and Template ID](https://docs.vambe.me/reference/whatsapp-message/send-a-template-message.md): Send a WhatsApp template to a single recipient using path params phone and templateId. Provide template variables in the body. Requires x-api-key. Optional from-phone-number query to select the sender phone. - [Send WhatsApp Template (Body-based v2)](https://docs.vambe.me/reference/whatsapp-message/send-a-template-message-1.md): Send a WhatsApp template using a JSON payload. Include recipient, template, and variables in the body. Requires x-api-key. - [Send WhatsApp Smart Template (Unstructured Data, Single Recipient)](https://docs.vambe.me/reference/whatsapp-message/send-a-template-message-with-unstructured-data.md): Send a WhatsApp smart template by templateId. Provide unstructured data in JSON or multipart form-data; AI maps it to template variables. Important: include the end user's phone number or a resolvable contact identifier in the payload so the AI knows the recipient. Supports optional integrationData… - [Send WhatsApp Smart Template to Many (Bulk, Unstructured Data)](https://docs.vambe.me/reference/whatsapp-message/send-a-template-message-with-unstructured-data-1.md): Bulk-send a WhatsApp smart template by templateId. Send a JSON array of items; AI maps each item to template variables. Important: each array item must include the end user's phone number or a resolvable contact identifier so the AI can determine the recipient. JSON only. x-api-key can be passed as… ## OpenAPI Specs - [openapi](https://docs.vambe.me/openapi.json)