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

{
  "agentId": "agent-123",
  "conversationId": "conv-456",
  "name_formatted_name": "John Doe",
  "phone_1_phone": "+1234567890",
  "phone_1_type": "CELL",
  "email_1_email": "john@example.com",
  "org_company": "ChatVolt",
  "org_title": "Developer"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required

The ID of the agent.

conversationId
string
required

The ID of the conversation.

name_formatted_name
string
required

Full name as it should appear.