Skip to main content
POST
Send contact
Being implemented. Only one contact per message works today: attachments accepts a list, but nothing from the second item on is sent.We also carry only name and phones. Meta accepts up to 257 contacts in one send, and on each one also email, address, organization, birthday and website.We are extending the endpoint. Until then, send one contact per request.

Overview

Sends a contact to a recipient. The content.type field must be CONTACT. You can send multiple phone numbers in the phones array.
Details of the Meta Cloud API rule in conversation window. See what each channel accepts for every channel.
If the channel is disconnected, the API refuses the send with 422 and subCode CHANNEL_DISCONNECTED, and the message is not sent. See Send errors.

Authorizations

Authorization
string
header
required

Secret Key generated in the Omni Z-API Security panel

Path Parameters

channelId
string
required

Channel ID

Example:

"YOUR_CHANNEL_ID"

Body

application/json
recipient
object
required
content
object
required

Response

Message sent successfully

messageId
string

Sent message ID — 32-character uppercase hexadecimal string