Sign in
Conversations

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.

post/conversations

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/conversations
  • Auth: httpBearer (a scheme the document does not define)

Request body

idstring object-id
customerstring object-id required
externalIdstring
namestring
status'open' | 'done'
priorityinteger
createdAtstring date-time
importedAtstring date-time
direction'in' | 'out'
replyChannelstring nullable
tagsstring[]
assignedUsersstring[]
assignedTeamsstring[]
customobject
defaultLangstring nullable

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.