Skip to main content
POST
Send a contact card

Authorizations

Authorization
string
header
required

Your API key, e.g. gr_live_…

Headers

Idempotency-Key
string
required

Your own unique id for this request (at most 255 characters). The same id and body within 24 hours answers the first answer again — never a second send or charge.

Maximum string length: 255

Body

application/json
to
string
required

The person's WhatsApp number with its country code, e.g. +9198250***** — or their WhatsApp username id (e.g. "IN.1626…"; see Customer).

contacts
object[]
required
reference
string

Your own reference for this message (at most 512 characters). It comes back on the message and its webhooks.

Maximum string length: 512
reply_to
string

The id of a message to quote.

Response

Accepted for sending.

id
string
status
string
to
string | null
customer
object

Who the customer is. phone can be null: a customer who uses a WhatsApp username may not share their number. user_id is WhatsApp's business-scoped user ID (for example "IN.13491208655302741918").

country
string
category
string | null
price
string | null
reference
string | null