v1

latestOpenAPI 3.0.32026-07-246376162.1 KB

Messaging

Create conversation

Initiate a new conversation for WhatsApp channels.

post/api/v4/messaging/conversations

Request body

channel_profile_idinteger required

The unique identifier of the channel profile.

contact_channel_identifierstring required

Channel-specific identifier of the contact (phone number for WhatsApp).

user_idinteger

The unique identifier of the user assigned to the conversation.

Example request

{
  "channel_profile_id": 1,
  "contact_channel_identifier": "15551234567",
  "user_id": 1,
  "message": {
    "content_type": "whatsapp_template",
    "content_data": {
      "whatsapp_template_id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "placeholders": {
        "1": "John",
        "2": "01 Jan 2026"
      }
    }
  },
  "source": {
    "system": "zoho",
    "account_id": "123321"
  }
}

Response

Created

Example response

{
  "conversation": {
    "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
    "channel_profile": {
      "id": 12,
      "channel": "whatsapp",
      "identifier": "18885658889",
      "name": "WhatsApp Main (18885658889)"
    },
    "contact_channel_account": {
      "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "channel": "whatsapp",
      "identifier": "15551234567",
      "data": {
        "name": "John Smith",
        "username": "johnsmith"
      }
    },
    "user": {
      "id": 1,
      "name": "Jane Doe",
      "email": "jane.doe@contactcenter.com"
    },
    "flow": {
      "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "name": "Lead Qualification"
    },
    "queue": {
      "id": 1,
      "name": "Technical Support"
    },
    "status": "active",
    "created_at": "2026-01-15T10:30:00.123000Z",
    "updated_at": "2026-01-20T14:15:00.456000Z"
  }
}