Built on the official Meta WhatsApp Business API Official Meta WhatsApp Business API See plans

Use the API

4 min read Updated 19 Nov 2026

Use the API when you want your own website, app or software to talk to your WhatsApp account, for example to read contacts or send a message. This guide is for people who work with a developer or know basic API calls. You need an active plan and a connected WhatsApp number.

Find your API endpoint and key#

  1. Open the API screenClick API in the left menu, under the API heading at the bottom. The page title is API Details.
  2. Read API CredentialsYou will see two read-only boxes: API Endpoint (the base address of the platform) and API Key (your personal key).
  3. Copy a valueClick the copy icon at the right of a box. A small Copied message appears. Paste the value into your developer's settings.
  4. Open the documentationThe API Documentation box has a See API Documentation button when the platform has published a documentation link. If you do not see the button, no link has been set yet.
Important

Your API key is like a password. Share it only with people who must have it, and never paste it in public places such as social media, chat groups or website code that visitors can read. If you think it has leaked, contact support.

yourdomain.com/client/api
API Details

API Credentials

API Endpoint
https://yourdomain.com 1
API Key
xxxxxxxxxxxxxxxxxxxx 2

API Documentation

Use the documentation to build your integration.
See API Documentation3
The API Details page. The copy icon beside each box copies the value. The key shown here is a placeholder.
  1. API Endpoint
  2. API Key (treat it like a password)
  3. Documentation button, shown only when a link is set

How requests are authenticated#

Every API address starts with your endpoint followed by /api/. Each request needs your API key in a header called apikey. Most calls also need a login token, which you get by signing in through the API with the email and password of a panel user.

StepWhat to send
1. Sign inPOST to /api/login with header apikey and the fields email and password. The reply contains a token.
2. Call other endpointsSend the header apikey and the header Authorization: Bearer YOUR_TOKEN on every call.

Replies are JSON with success, message and data.

API keyCopied from the API screen
POST /api/loginHeader apikey, plus email and password
TokenReturned in the reply
Call an endpointHeaders apikey and Authorization: Bearer
JSON replysuccess, message, data
The path of one request, from your key to the reply. A made-up example of a reply: {"success": true, "message": "Message sent successfully", "data": {"message_type": "text", "conversation_id": 123, "remaining_conversations": 1499}}

Endpoints you can use#

These endpoints exist in the platform. Addresses are written after the /api/ part.

AddressWhat it does
POST loginSign in and get a token
GET profileRead the signed-in user
GET whatsapp-contactList your active contacts, 10 per page
POST whatsapp-contact-storeAdd a contact
GET whatsapp-contact-listList your contact lists
GET whatsapp-segmentList your segments
GET whatsapp-templatesList your templates, 50 per page
GET whatsapp-campaignList your campaigns
POST send-messageSend a text, image or document message to a contact
POST whatsapp/send-templateSend a template message to a contact

Send your first message#

  1. Sign inCall POST /api/login as described above and keep the token from the reply.
  2. Find the contact IDCall GET /api/whatsapp-contact. Each contact in the reply has an ID. Use that ID, not the phone number.
  3. Send the messageCall POST /api/send-message with the fields receiver_id (the contact ID) and message. To send a file, send image or document instead of a message.
  4. Check the replyA successful reply says the message was sent and shows remaining_conversations, which is how many conversations are left on your plan.
Note

As per Meta's rules, free-form messages can be delivered only inside the 24-hour customer service window. Outside it, send an approved template with whatsapp/send-template. Sending uses up conversations and campaigns from your plan, so watch your limits.

Common problems#

"API key missing" (401)

The apikey header was not sent. Add it to every request.

"API key invalid" (403)

The key does not match any account. Copy it again from the API screen without extra spaces.

"Invalid Credentials" or a token error

The email or password is wrong, or the token has expired or is missing. Sign in again and send the new token. A banned, unverified or suspended user cannot sign in.

"Insufficient Conversation Limit"

Your plan has no conversations left. See Manage your subscription and billing to check usage or upgrade.

"Contact not found"

The ID does not belong to a contact in your account. Fetch the contact list again and use the ID from there.

Open the API screen

Need help?#

Contact support on WhatsApp +91 99159 60958 or email info@whatsappmarketingagency.com, or use the contact page.

Was this guide helpful?
Black Friday Sale – Get 20% OFF!
Latest offer

Black Friday Sale – Get 20% OFF!

Unlock smarter business communication this Black Friday! Enjoy 20% OFF on all WhatsApp Marketing Agency plans, including WhatsApp Business API, bulk messaging, AI chatbots, CRM integration and automation. Use coupon code BLACKFRIDAY20 at checkout. Limited-time offer: 27–30 November 2026.

Claim 20% OFF Now