Skip to content

Platform API ​

With the ChatBooster Platform API, your own systems (CRM, e-commerce backend, membership system and so on) can create and update contacts, look up contacts, and send WhatsApp messages to contacts.

The following endpoints are available:

EndpointMethod and pathWhat it does
Create or update a contactPOST /v2/contact/createOrUpdateCreate a contact by phone number, or update an existing contact's details, tags, lists and custom fields
List contactsPOST /v1/contact/listFilter contacts by tag, list, channel, phone, email, update time or custom field
Send a message to a contactPOST /communicateSrvCloudAPI/message/v1/sendToContactSend text, an image, a video or a file to a contact

Scope

The Platform API currently supports contacts on WhatsApp channels only.

Before you start ​

  • Your workspace plan must include the Platform API feature.
  • Your workspace has at least one WhatsApp channel connected.

Get your API key ​

  1. Log in to ChatBooster and go to Settings → Platform API.
  2. Click the copy icon to copy the API key.

Each workspace has one API key. When you click Regenerate API key, the old key stops working immediately and every call that uses it will fail. This cannot be undone.

Keep your API key safe

The API key grants access to your workspace. Use it from your server only. Do not put it in a web front end, a mobile app or a public code repository.

Making requests ​

Base URL

https://api.chatbooster.ai

Request headers

HeaderValue
AuthorizationYour API key, as is (no Bearer prefix)
Content-Typeapplication/json

All endpoints use POST, and request and response bodies are JSON.

Response format

Every endpoint returns Code and Message. Use the Code in the response body to tell whether the call succeeded, not the HTTP status code.

CodeMeaning
200Success
400Invalid request parameters
401The API key is invalid (Authorization invalid), or the workspace plan does not include the Platform API (Invalid Permission In CloudAPI)
404Contact not found
500The request failed; see Message for details

Troubleshooting ​

What you seeWhat to do
Authorization invalidCheck that the Authorization header holds your current API key with no Bearer prefix. After a key is regenerated, the old one no longer works
Invalid Permission In CloudAPIThe workspace's current plan does not include the Platform API. Upgrade the plan
ChannelType must be whatsappChannelType only accepts "whatsapp" for now
telephone is invalidTelephone must include the country code, for example +85261234567
tag[...] not exist / list[...] not existCreate the tag or list in ChatBooster first, then call again

Questions? Contact [email protected].