Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id
string
required

Bot id

x-integration-id
string

Integration id

x-integration-alias
string

Integration alias

Body

application/json

Conversation data

channel
string
required

Channel name

Maximum string length: 200
tags
object
required

Tags for the Conversation

integrationName
string
deprecated

[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.

Maximum string length: 200
discriminateByTags
string[]

Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.

Maximum string length: 500

Response

Returns a Conversation object if a valid identifier was provided. Returns an error otherwise

conversation
object
required

The Conversation object represents an exchange of messages between one or more users. A Conversation is always linked to an integration's channels. For example, a Slack channel represents a conversation.

meta
object
required
Last modified on March 20, 2026