Reference
API reference
51 endpoints, grouped by family. Each one: what it does, its fields, its response, its refusals, and an example in cURL, Node.js and Python.
Endpoint descriptions are in English, the language of integration.
- GET
/contactsList contacts - POST
/contactsCreate a contact - GET
/contacts/{id}Get one contact - PATCH
/contacts/{id}Update a contact - GET
/contacts/{id}/notesList notes on a contact - POST
/contacts/{id}/notesAdd a note to a contact - DEL
/contacts/{id}/notes/{noteId}Delete a note - GET
/contacts/attributesList the custom contact fields - DEL
/privacy/contacts/{id}Erase a person, for good
- GET
/inbox/categoriesList the labels of the inbox - GET
/inbox/conversationsList conversations - POST
/inbox/conversationsWrite first to someone who has not written yet - GET
/inbox/conversations/{id}Get one conversation - POST
/inbox/conversations/{id}/aiLet the AI collaborator answer this thread, or stop it - POST
/inbox/conversations/{id}/assignHand a conversation to someone - DEL
/inbox/conversations/{id}/blockUnblock the contact of a conversation - POST
/inbox/conversations/{id}/blockBlock the contact of a conversation - DEL
/inbox/conversations/{id}/categoryClear the label of a conversation - POST
/inbox/conversations/{id}/categoryPut a conversation in a queue - DEL
/inbox/conversations/{id}/linkDetach the record of a conversation - POST
/inbox/conversations/{id}/linkAttach a record to a conversation - POST
/inbox/conversations/{id}/mediaSend a file in a conversation - GET
/inbox/conversations/{id}/messagesList the messages of a conversation - POST
/inbox/conversations/{id}/messagesReply in a conversation - POST
/inbox/conversations/{id}/needs-humanFlag a conversation as needing a person - POST
/inbox/conversations/{id}/readMark a conversation as read - POST
/inbox/conversations/{id}/statusChange the state of a conversation - POST
/inbox/conversations/{id}/templateSend an approved template - POST
/inbox/conversations/{id}/typingShow "typing…" to the customer - GET
/inbox/membersList the people who can take a conversation - GET
/inbox/overviewCount the folders, labels and mailboxes
- GET
/webhooksList your webhook subscriptions - POST
/webhooksSubscribe to events - DEL
/webhooks/{id}Unsubscribe - PATCH
/webhooks/{id}Change a subscription - POST
/webhooks/{id}/rotate-secretRotate the signing secret - POST
/webhooks/{id}/testSend a test call - GET
/webhooks/deliveriesList deliveries - POST
/webhooks/deliveries/{id}/redeliverRedeliver an event