Get your API key
Every request needs an API key. Open the API Developer Console in ChatSyncs — your key is shown at the top of that page asYour API key.
Base URL
/whatsapp/send
means https://platform.chatsyncs.com/api/v1/whatsapp/send.
Authentication
Pass your API key as theapiToken parameter on every request — either as a query parameter
(GET) or a form field (POST):
apiToken parameter, and answers a Bearer header alone with The api token field is required.):
{"status":"0","message":"Unauthenticated."}. With no key at all,
the API redirects to the ChatSyncs login page (HTTP 302, an HTML page) instead of returning JSON — if you get HTML back,
your key is missing.
Making requests
Every endpoint accepts both GET and POST with the same parameters — a query string on GET, or form fields (-d with curl) on POST — except Upload Media, which is POST-only. Use POST for anything that changes data, so
values stay out of URLs and server logs.
For GET requests, URL-encode any parameter that contains spaces or special characters (e.g. a
text
message).There’s no official ChatSyncs SDK package yet. The code samples on each endpoint page
(cURL, Node.js, Python, PHP) are plain HTTP calls using each language’s standard library —
fetch, requests, and curl/file_get_contents — not calls into a published package.Quickstart
phone_number_id — this identifies which of your
connected WhatsApp numbers (bots) the request acts on. Find it under Chatbot Manager → (your
bot) → Change Settings, or call Get My Info: its
whatsapp_bots_details lists every connected number with its phone_number_id.
Request flow
Reading the response
Every response is JSON with astatus field:
"status": "1"(ortrueon a few endpoints) — the request succeeded. Amessagefield usually confirms what happened, or is the requested data: endpoints that return rows (Subscriber List, Get Conversation, Label List, Bot Template Get…) put them inmessageas a list. There is nodatafield, except on Custom Fields List."status": "0"(orfalse) — the request failed.messageexplains why, e.g."WhatsApp account not found."or"The phone number id field is required."Several missing fields are listed together, separated by commas.
Pagination
List endpoints (Subscriber List, Get Conversation) acceptlimit (the page size) and offset (the page
number, starting at 1 — not a count of rows to skip) to page through results. The response carries nextOffset,
the value to send next, and null on the last page. See the worked example on
Subscriber List.
Frequently asked
Where do I get my API key?
Where do I get my API key?
Open the API Developer Console in ChatSyncs — your key is shown at the top of that
page. Use the key already shown: generating a new one replaces the old.
Do I send my API key as a header or a parameter?
Do I send my API key as a header or a parameter?
Either works on every endpoint: the
apiToken parameter (query string on GET, form field on
POST), or Authorization: Bearer YOUR_API_KEY.How do I know if my request actually worked?
How do I know if my request actually worked?
Check the
status field in the JSON response — "1" (or true) means success, "0" (or
false) means failure, with a message explaining what went wrong.What is phone_number_id and where do I find it?
What is phone_number_id and where do I find it?
It identifies which connected WhatsApp number/bot the request applies to. You’ll find it in
Chatbot Manager for that bot.

