Create a conversation

Creates a new empty conversation. In Conversation mode, it is generally not needed to create a conversation explicitly since sending or receiving a message automatically creates a new conversation if it does not already exist between the given app and contact. Creating empty conversation is useful if the metadata of the conversation should be populated when the first message in the conversation is a contact message or the first message in the conversation comes out-of-band and needs to be injected with InjectMessage endpoint.

Request body

activeboolean

Flag for whether this conversation is active.

The identifier of the channel you want to include. Must be one of the enum values.

app_idstring

The ID of the participating app.

contact_idstring

The ID of the participating contact.

metadatastring

Arbitrary data set by the Conversation API clients. Up to 1024 characters long. NOTE: This field has been deprecated due to changes in the system architecture or functionality. It is no longer actively maintained and may be removed in future versions. Please avoid relying on this field in new code.

metadata_jsonobject

Arbitrary data set by the Conversation API clients and/or provided in the conversation_metadata field of a SendMessageRequest. A valid JSON object.

correlation_idstring

Arbitrary correlation ID related to the MT message set by the Conversation API user.

Example request

{
  "active_channel": "WHATSAPP"
}

Response

A successful response.