Conversations API: Create a conversation
gapify_client_create_conversationCreate a customer-support conversation in a specific inbox for a contact, adding custom attributes to start or organize support threads.
Instructions
Create a conversation [Conversations API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations Body fields: custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"inbox_identifier": "<inbox_identifier>",
"contact_identifier": "<contact_identifier>"
},
"name": "gapify_client_create_conversation"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). | |
| inbox_identifier | Yes | The identifier obtained from API inbox channel | |
| custom_attributes | No | Custom attributes of the conversation Example: {} | |
| contact_identifier | Yes | The source id of contact obtained on contact create |