Use stable customer resources to build the wider workflow.

Authenticate and verify the workspace.

Send Authorization: Bearer YOUR_API_KEY over HTTPS, keep keys in server-side secret storage and call the verification operation before running a production workflow.

• GET /api/v1/verify verifies the key and workspace
• GET /api/v1/health checks API availability
• A 401 response means the credential is missing or invalid

Work with contacts, leads and groups.

Use stable UUIDs for customer records. Contact groups can support deliberate segmentation while lead updates keep the commercial state attached to the person.

• GET and POST /api/v1/contacts
• GET, PUT and DELETE /api/v1/contacts/{uuid}
• POST /api/v1/leads
• GET, POST, PUT and DELETE /api/v1/contact-groups

Send text, templates and rich message types.

Choose the operation that matches the actual message. Approved templates, marketing templates, media, locations, contact cards and catalog products each have distinct request requirements.

• POST /api/v1/send
• POST /api/v1/send/template
• POST /api/v1/send/marketing-template
• POST /api/v1/send/media
• POST /api/v1/send/location
• POST /api/v1/send/contacts
• POST /api/v1/send/product

Read conversations, templates and canned replies.

Retrieve conversation context and approved templates, then create or maintain canned replies for repeatable team answers.

• GET /api/v1/chats
• GET /api/v1/templates
• GET and POST /api/v1/canned-replies
• PUT and DELETE /api/v1/canned-replies/{uuid}

Handle failures without duplicating customer actions.

Treat validation and authorization errors as permanent until the request changes. Retry temporary service failures with bounded backoff and use your own idempotency controls for actions that must not be repeated.

• Log the method, path, status and a safe request identifier
• Never log bearer keys or sensitive message content by default
• Reconcile the customer record before replaying a write

Use the full developer portal.

The developer portal explains each operation with exact request fields, readable examples, response payloads, implementation notes, and possible errors.

Open the complete reference at /developers.