WhatsApp API for Developers: SaleMag REST API

You built the order system, the ERP sync or the shop app. Now the business wants a WhatsApp message when an order ships. Going straight to Meta's Cloud API means template management, phone number IDs, token handling and an inbox for the replies. That is weeks of work before the first message.

SaleMag's REST API gives you that layer ready-made. Your code calls one endpoint, and the reply lands in the same inbox the support team already uses.

A REST API is a set of HTTPS endpoints that lets another program read and change data with JSON requests. SaleMag's REST API connects your systems to the contacts, campaigns, WhatsApp numbers and AI agents in your SaleMag workspace.

What can I do with the SaleMag REST API?

The SaleMag REST API lets your code manage contacts, campaigns, messages, conversations, AI agents, automations, social posts and analytics. Every endpoint lives under /api/v1 and returns JSON:

Contact lists use cursor pagination, 25 per request: follow meta.next_cursor for the next batch.

How does SaleMag API authentication work?

The SaleMag API uses personal access tokens sent as a bearer header, each limited to the scopes you choose. Create one on the API Tokens page:

Authorization: Bearer {token}

• Copy the whole token, including the number and | before it. It is shown only once and stored as a hash.
• Set an expiry date, or leave it open.
• Pick scopes from the 12 available: contacts:read, contacts:write, campaigns:read, campaigns:write, messages:write, conversations:read, webhooks:write, ai:read, ai:write, automations:write, social:write and analytics:read. Choosing none gives the token full access (*).
• The owner's workspace role still applies, so a token can never do more than the person who made it.

A call without the needed scope returns 403 with a required_scope field that names it.

How do I send a WhatsApp message with the API?

Send a WhatsApp message by calling POST /api/v1/messages/send with a contact id and the messages:write scope. The contact must exist in SaleMag with an E.164 phone number, so create it first:

curl -X POST \
  -H "Authorization: Bearer $SALEMAG_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"phone_e164":"+8801700000001","first_name":"Rahim","opt_in_whatsapp":true}' \
  https://your-salemag-domain/api/v1/contacts

The new contact comes back under data, with its id. Then send an approved template:

curl -X POST \
  -H "Authorization: Bearer $SALEMAG_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"contact_id":42,"channel":"whatsapp","template_name":"order_confirmation","template_vars":{"1":"ORD-99"}}' \
  https://your-salemag-domain/api/v1/messages/send

A success returns {"provider_message_id": "wamid...", "status": "sent"}.

What to know before you build on it:

Customer replies arrive in the unified inbox. To message many contacts at once, create and launch a campaign through the API instead; see Broadcasting.

What are the SaleMag API rate limits?

The SaleMag API allows 60 requests per minute per user across /api/v1, with a second limit on sending messages:

For large sends, use a campaign. SaleMag paces campaign messages itself.

Is there an OpenAPI spec or SDK for the SaleMag API?

Yes, there is an OpenAPI spec; there is no SDK. The OpenAPI 3.1 document at /api/v1/openapi.json is public, so Postman, Insomnia or a code generator can read it without a token. Inside the app, the API reference page lists every endpoint with parameters, example payloads and curl commands filled with your own base URL.

Errors are JSON: business errors use an error key, and validation errors return 422 with a message and an errors object.

Does the SaleMag API send webhooks?

Yes. SaleMag can POST a signed JSON event to your server when a contact is created, a message arrives or a campaign finishes. You register endpoints in the app or through the /webhooks endpoints of this API. Events, signature checks and retries are covered on the webhooks page.

What can I build with the SaleMag API?

The SaleMag API can sync customers, send order updates and put AI answers into your own app:

Who is the SaleMag API for?

The SaleMag API is for developers and agencies who connect SaleMag to an online store, ERP, CRM or custom app. If you want the automation without code, the automation flow builder can call your URL with its HTTP request step.

Ready to make your first call? Create an account and open API Tokens, or compare plans.