API reference.

API v2

One API for WhatsApp (scan QR) and WhatsApp Official: send text, files, templates, and OTP codes, reply to conversations, manage contacts, and read channels and templates. Test keys reach test numbers only.

• POST/api/v2/messagesSend a message. One endpoint for WhatsApp (scan QR) and WhatsApp Official: text, a file, a template, or an OTP code.
• GET/api/v2/messages/{id}Message status. Status and error of a message sent by this key.
• GET/api/v2/conversationsList conversations. Conversations the key's creator can see, newest first.
• GET/api/v2/conversations/{id}Conversation details. One conversation the key's creator can see.
• GET/api/v2/conversations/{id}/messagesMessages in a conversation. Messages of one conversation, newest first.
• POST/api/v2/conversations/{id}/messagesReply to a conversation. Reply with text or a file in a conversation the key's creator can see, on any channel the Inbox can reply on.
• GET/api/v2/contactsSearch contacts. Contacts the key's creator can see, most recently updated first.
• POST/api/v2/contactsCreate a contact. Add a new contact with a number or an email.
• GET/api/v2/contacts/{id}Contact details. One contact the key's creator can see.
• PATCH/api/v2/contacts/{id}Update a contact. Change contact fields; only the fields sent change.
• GET/api/v2/channelsList channels. WhatsApp numbers this key may use, with their status.
• GET/api/v2/templatesList templates. WhatsApp Official templates with the variables to fill.
• POST/api/v2/templatesSubmit a template. Submit a new WhatsApp Official template for approval.
• GET/api/v2/webhooksList webhooks. This business's webhooks, with their events, 7-day health, and number of failed deliveries.
• POST/api/v2/webhooksAdd a webhook. Register your system's HTTPS URL and the events you want to receive.
• GET/api/v2/webhooks/{id}Webhook details. One webhook with its events and health.
• PATCH/api/v2/webhooks/{id}Update a webhook. Change the URL, events, or description, or pause and reactivate it.
• DELETE/api/v2/webhooks/{id}Delete a webhook. Delete a webhook together with its delivery log.
• POST/api/v2/webhooks/{id}/testSend a test event. Send a sample of one event (marked `test: true`) now, then see your system's response.
• GET/api/v2/meMy key. The key type, the permissions it can use right now, and the channels it may use.