Skip to main content
POST

Authorizations

Authorization
string
header
required

Create an API key in GreenTick Developer settings. Send it as Authorization: Bearer gt_live_… (Bearer prefix required).

Body

application/json
to
string
required

Recipient phone with country code. Non-digits are stripped and leading zeros removed, then validated (e.g. +91 98765 43210 → 919876543210). Invalid numbers return 400 INVALID_TO.

Example:

"919876543210"

type
string
required
Allowed value: "text"
text
string
required
Maximum string length: 4096
phoneNumberRef
string
required

GreenTick phone line ref from GET /phone-numbers (ref field).

Example:

"668f1a2b3c4d5e6f7a8b9c0a"

Response

Message accepted by WhatsApp

success
boolean
Example:

true

data
object