Interactive Messages
Send Contact
Sends one or more contact cards. Supported on WhatsApp, Z-API, and ZapperAPI.
POST
/
messages
/
interactive
/
send-contact
Sends one or more contact cards. This is supported on WhatsApp, Z-API, and ZapperAPI channels.
Request Body
The API uses a dynamic schema to reconstruct a contact object from flat parameters.
agentId: The ID of the agent.conversationId: The ID of the conversation.name_formatted_name: Full name as it should appear.name_first_name: (Optional) First name.name_last_name: (Optional) Last name.phone_1_phone: Phone number (at least one required for Z-API/ZapperAPI).phone_1_type: (Optional) Type of phone (e.g.,CELL,WORK).email_1_email: (Optional) Email address.email_1_type: (Optional) Type of email (e.g.,WORK,HOME).org_company: (Optional) Company name.org_title: (Optional) Job title.url_1_url: (Optional) Website URL.
Example
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
agentId
string
requiredThe ID of the agent.
conversationId
string
requiredThe ID of the conversation.
name_formatted_name
string
requiredFull name as it should appear.
Was this page helpful?

