Create conversation

Creates a new conversation.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.conversation.writeorg.permission.conversation.create

Custom Attributes

Custom attributes are optional and allow you to specify custom key-value pairs.

Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

Naming Suffix

  • Num number or null
  • At date-time or null
  • Str string or null, length: [ 0 .. 1024 ] characters
  • Txt string or null, length: [ 0 .. 1024 ] characters
  • Bool boolean or null
  • Url string or null, format: uri

Rate Limit

Conversations are subject to a rate limit. A single client can create up to 120 conversations per minute per customer.

Conversations with importedAt in their body will not be subject to the rate limit.

A 429 Too Many Requests response will be returned if the rate limit has been reached for a customer.

Language
Authentication
Bearer
Click Try It! to start a request and see the response here!