conversation_create_payload

source_idstringrequired

Conversation source id

Example: 1234567890

inbox_idinteger

Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email

Example: 1

contact_idinteger

Contact Id for which conversation is created

Example: 1

additional_attributesobject

Lets you specify attributes like browser information

Example: {"browser":"Chrome","browser_version":"89.0.4389.82","os":"Windows","os_version":"10"}

custom_attributesobject

The object to save custom attributes for conversation, accepts custom attributes key and value

Example: {"attribute_key":"attribute_value","priority_conversation_number":3}

statusstring

Specify the conversation whether it's pending, open, closed

Possible values: [open, resolved, pending]

Example: open

assignee_idinteger

Agent Id for assigning a conversation to an agent

Example: 1

team_idinteger

Team Id for assigning a conversation to a team\

Example: 1

snoozed_untilstring<date-time>

Snoozed until date time

Example: 2030-07-21T17:32:28Z

message object

The initial message to be sent to the conversation

contentstringrequired

The content of the message

Example: Hello, how can I help you?

template_params object

The template params for the message in case of whatsapp Channel

namestring

Name of the template

Example: sample_issue_resolution

categorystring

Category of the template

Example: UTILITY

languagestring

Language of the template

Example: en_US

processed_paramsobject

The processed param values for template variables in template

Example: {"1":"AzChat"}

conversation_create_payload

{
  "source_id": "1234567890",
  "inbox_id": 1,
  "contact_id": 1,
  "additional_attributes": {
    "browser": "Chrome",
    "browser_version": "89.0.4389.82",
    "os": "Windows",
    "os_version": "10"
  },
  "custom_attributes": {
    "attribute_key": "attribute_value",
    "priority_conversation_number": 3
  },
  "status": "open",
  "assignee_id": 1,
  "team_id": 1,
  "snoozed_until": "2030-07-21T17:32:28Z",
  "message": {
    "content": "Hello, how can I help you?",
    "template_params": {
      "name": "sample_issue_resolution",
      "category": "UTILITY",
      "language": "en_US",
      "processed_params": {
        "1": "AzChat"
      }
    }
  }
}