Skip to main content
All endpoints require authentication.

Contacts

List Contacts

GET /api/contacts

Create Contact

POST /api/contacts
Body
FieldTypeRequiredDescription
namestringYesContact full name
phonestringNoPhone number with country code (for WhatsApp)
emailstringNoEmail address
sourcestringNowhatsapp, facebook, manual

Get Contact

GET /api/contacts/:id

Update Contact

PATCH /api/contacts/:id
Updatable fields include name, phone, email, optIn, replyBot, status.
FieldTypeDescription
optInbooleanWhether the contact consents to receive messages
replyBotbooleanEnable/disable bot auto-replies for this contact
statusstringopen, pending, resolved

Delete Contact

DELETE /api/contacts/:id

Contact Lists

List Contact Lists

GET /api/contact-lists

Create Contact List

POST /api/contact-lists
Body
FieldTypeRequiredDescription
namestringYesList label