API Reference

Send a WhatsApp message

post
https://api.chatarmin.com/api/public/messages/send

Send a WhatsApp message to a contact. Supports text, image, video, document, and template message types. Identify the recipient with phone, email, or contactId. For media messages, provide a publicly accessible URL via mediaUrl.

Template messages can be sent at any time. Non-template messages can only be sent within the 24-hour customer service window.

Language codes: use the WhatsApp language code the template was approved with in Meta (e.g. "de", "en", "en_US"). Language names like "German" are rejected with 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Payload for sending a WhatsApp message. Provide exactly one of phone, email, or contactId to identify the recipient.

string

Phone number of the recipient (international format).

string

Email of the recipient (used to look up the contact).

string

Contact ID or externalId of the recipient.

string
enum
required

The type of message to send.

Allowed:
string

Message body text. Required when type is "text".

uri

Publicly accessible URL of the media file. Required when type is "image", "video", or "document".

string

Optional caption for media messages (image, video, document). Max 1024 characters.

string

Optional file name for document messages.

string

Exact name of the approved WhatsApp template. Required when type is "template".

string
^[a-z]{2}(_[A-Z]{2})?$

WhatsApp language code of the template (e.g. "en", "de", "en_US"). Required when type is "template".

components
array of objects

Template components used to fill dynamic placeholders.

components
Responses

Updated 12 days ago

Did this page help you?
Language
Credentials
Bearer
API Token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago

Did this page help you?