Skip to main content
inputCreateThreadInput

Fields

customerIdentifier
CustomerIdentifierInput!
required

The identifier of the customer being either the existing customer ID, the customer's email address or an external ID.

title
String

The title of the thread.

components
[ComponentInput!]
deprecated

The components used to create the first timeline entry in the thread.

Use sendChat and sendCustomerChat mutations instead. Both allow you to backdate messages.
attachmentIds
[ID!]
deprecated

An array of attachments for the first timeline entry in the thread.

Use sendChat and sendCustomerChat mutations instead. Both allow you to backdate messages.
labelTypeIds
[ID!]

An array of label types to attach to the thread upon creation.

threadFields
[CreateThreadFieldOnThreadInput!]

An array of thread fields to attach to the thread upon creation.

assignedTo
CreateThreadAssignedToInput

User or machine user this thread should be assigned to.

externalId
ID

The external ID of this thread. You can use this field to store your own unique identifier for this thread.

description
String

The optional description for this thread. This is used to display a preview of the thread in the UI. If not provided, we will automatically infer it from the components you provided.

priority
Int

The priority of the thread. Valid values are 0, 1, 2, 3, from most to least urgent, defaults to 2 (normal).

tenantIdentifier
TenantIdentifierInput

A thread may be assigned to a specific tenant.

channel
ThreadChannel

The channel to create the thread for. Currently supported: API, EMAIL, SLACK, MS_TEAMS, CHAT, or INTERNAL. Defaults to API.

channelDetails
ThreadChannelDetailsInput

Channel details for the thread, required if channel is SLACK or MS_TEAMS