1. Conversations API
Hatif
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts [Complex]
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Delete Contact
      DELETE
    • Create Bulk Contacts vCards
      POST
    • Create Contact
      POST
    • Get Contacts Search
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
      GET
    • Delete Contact Property
      DELETE
    • Update Contact Property
      PUT
    • Create Contact Property
      POST
    • Contact Properties Statistics
      GET
  • Support API
    • Upload Audio File
  • Outbound IVR API
    • Create Outbound IVR
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
      GET
    • List Conversations
      GET
    • Create Conversation
      POST
    • Assign Conversation
      POST
    • Get Conversation
      GET
  • Tags API
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ConversationDto
    • CreateTagDto
    • ChannelConversationDto
    • UpdateTagDto
    • TagDto
    • ConversationTimelineDto
    • PagedResultOfTagDto
    • AiSummaryDto
    • ReplyInfoDto
    • InternalThreadDto
    • LocationMessageDto
    • AssignationInfoDto
    • PagedResultOfConversationDto
    • PagedResultOfConversationTimelineDto
  1. Conversations API

Create Conversation

POST
/v2/conversations/service-account/create
Creates a conversation for a contact. Returns existing conversation if it exists. Optionally assigns to a user or AI agent.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/json

Examples

Responses

🟢200
application/json
Conversation created or retrieved successfully
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.voxa.sa/v2/conversations/service-account/create' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "ChannelId": "3a197b6e-e0b9-ce63-4664-a4d3eddae5a0",
    "PhoneNumber": "+966500888777",
    "ContactName": "Ahmed Ali",
    "AssignToUserId": null,
    "AssignToAiAgentId": null
}'
Response Response Example
{
    "conversation": {
        "id": "3a1a4cb7-e7c1-f045-127b-ad2297847528",
        "status": "Open",
        "lastActivityAt": "2026-02-19T01:52:46Z",
        "contactId": "3a18a7e6-48bf-e5b8-4935-867e4b6c6c02",
        "contactName": "Ahmed Ali",
        "phoneNumber": "+966500888777",
        "channelId": "3a197b6e-e0b9-ce63-4664-a4d3eddae5a0",
        "assigneeId": null,
        "assignedAiAgentId": null,
        "isAiAssignee": false,
        "assigneeName": null,
        "tags": [],
        "unreadCount": 0
    },
    "contactId": "3a18a7e6-48bf-e5b8-4935-867e4b6c6c02"
}
Modified at 2026-02-21 23:30:21
Previous
List Conversations
Next
Assign Conversation
Built with