Loading...

This is taking longer than expected.

The API module

Connect your own systems, such as your sales or billing software, to your team with an API token — how to switch the module on, create a token, give it to your system, send your approved templates from it and revoke it.

The API module lets the other systems your business uses — your sales or billing software, your ERP, a program of your own — talk to your Sync Pro team. With a token, a system can check which team and WhatsApp number it is connected to, read your approved templates with their text and variables, send one of them to a phone, and then check whether it arrived and was read.

Each token belongs to one team, acts with the permissions of the person who created it, and can be revoked on its own. It is not the same as an MCP token, which is for an AI assistant: an MCP token does not open the API, and an API token does not connect an AI assistant. See Connect your AI client with MCP.

Before you start

  • Switch the module on. The API module is free on every plan, and your team switches it on itself. Someone whose role has Manage Plans opens Add-ons from the menu, finds API and presses Activate. See Turning modules on and off.
  • Have the permission to manage tokens. Your role needs, under Permissions, either Manage Mcp Tokens or Edit Settings — the same ones as for MCP tokens. The team owner has both from the start.

Create a token

  1. Go to Settings → Integrations. When the API module is on and your role has Manage Mcp Tokens or Edit Settings, an API section appears there.
  2. Write a Token name that tells you which system will use it — for example, Control Total — and press Create token.
  3. Press Copy token and keep the token somewhere safe straight away. You will not be able to see it again. Press Done when you have it.

If you lose a token, you cannot recover it: create a new one and revoke the old. Use one token per system, so you can stop one without stopping the others.

Give it to your system

Whoever sets up the other system needs two things from the API section:

What Where
The address The API URL shown at the top of the section.
The token The token you copied. The system sends it in the Authorization header, as Bearer followed by the token.

The API answers your system in English, whatever language you use Sync Pro in, because the person who reads those answers is the one who programs the connection.

What your system can do

It works inside the team the token belongs to, and only as far as the person who created the token is allowed to go.

  • See which team it is connected to, with your WhatsApp number and its verified name when a number is linked.
  • Read your approved templates, one by one or all together, with their header, text, footer, buttons and variables, and which variables fill in from the contact's details. A verification code template, of the Authentication category, also shows whether it carries the security recommendation, how many minutes its code lasts and the text of its copy code button; when your system sends one, the code goes in the message and in that button. Templates cannot be created through the API. Only approved templates are shown, and only when your WhatsApp number is linked. If the person who created the token cannot see templates, neither can the system.
  • List your lead campaigns and your Kanban boards, with each board's columns in order and which one is the final column, so your system knows where it can place a contact. Campaigns are only listed while the Advanced Leads module is on.
  • Send an approved template to a phone, and then check whether it arrived: sent, delivered, read, or failed with the reason WhatsApp gave. See Send templates from your system.

Each token can make up to 600 requests a minute. Past that, the system is asked to wait a few seconds and try again.

Send templates from your system

Your system can send one of your approved templates to a phone — a quote, a reminder, a payment notice — without anyone opening the chat. It sends the phone, the contact's name, the template and the values of its variables, and Sync Pro sends it from your WhatsApp number.

  • The phone always carries its country code, such as 52 for Mexico: 529611235894 or +52 961 123 5894 both work. A phone without it is refused and nothing is sent.
  • If the contact already exists, the message goes to that contact's conversation, and its name and responsible users stay as they were. If it does not, Sync Pro creates the contact with the name your system sent.
  • The message is sent as the person who created the token. In the chat it shows under that person's name, with a Via API · token name badge next to its time, and again next to the sender's name when you open the message information, so you always know which system sent it. The contact's Activity History carries the same badge.
  • It counts toward your monthly contacts limit, like any message your team sends. When your team has reached its limit, nothing is sent to a contact who has not been served this month. See the monthly contacts limit in Chats and conversations.
  • A template can generate a Meta charge when it reopens a conversation's 24-hour window, the same as when you send it from the chat.

Nothing is sent when your WhatsApp number is not linked, when the template is not one of your approved templates, when a variable that does not fill in from the contact's details has no value, or when the template needs a new file in its header on every send — files cannot be sent through the API, so use a template without a header file or one whose header file is fixed. Your system is told which of these happened.

Your system can also say where the contact goes: a lead campaign and a column of one of your Kanban boards, each by the ID it got from the lists above. Both are optional.

  • Campaign. A new contact is created in that campaign. A contact who already exists gets it only when it has no campaign; one that already has a campaign keeps its own.
  • Column. When the contact is not yet on that column's board, a card is created for it in that column, it shows in the contact's Activity History, and the members who follow that board are told, as when any new contact arrives on it. When the contact is already on that board, its card is neither moved nor duplicated.
  • Both are kept even if WhatsApp then refuses the message, because they are set when the contact is created or found.

Nothing is sent and no contact is created when the campaign or the column is not one of your team's, when a campaign is sent while the Advanced Leads module is off, or when the column is the final column of its board. Your system is told which of these happened.

Your system can also give each send its own reference, such as the number of its quote. A template is never sent twice with the same reference: if your system repeats a send, it is told about the message already sent instead. Only when the last send with that reference failed does a repeat send it again, so your system can retry after fixing the problem.

The person who created the token needs Retrieve Lead in their role for the system to send templates or check them. The system can only check the messages sent through the API, never the ones written in the chat. To list or use campaigns, the person needs to see Lead Campaign; to list boards, to see Flow; and to place a contact in a column, to create in Flow Type Step. See Roles and permissions.

See what your systems asked

Every call a token makes appears in Api Requests, in the team menu, with api as its Source and the token's name as its Identifier, together with the answer it got — including the ones that were refused. See The API requests log.

In the API section, the list of tokens shows each one's Name, who it was Created by — Former member when that person's account was deleted — when it was Created and when it was Last used, or Never. Anyone who can manage tokens sees them all and can revoke any of them.

Revoking a token

In Settings → Integrations → API, press Revoke next to the token and confirm. It stops working right away; the other tokens keep working.

A token also stops working when:

  • the API module is switched off — every token of the team stops without being deleted, and they work again when it is switched back on;
  • the person who created it leaves the team;
  • the person who created it no longer has Manage Mcp Tokens nor Edit Settings, or their account is blocked — the token stays in the list, and works again if they get one of those permissions back.