Customers (Conversations)

Create conversation for customer

Creates a new, empty conversation for a customer.

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
post/customers/{id}/conversations

Request

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

Path parameters

idstring required
Example:58210c3db0f09110006b7953

Unique ID of the customer.

Request body

idstring object-id
externalIdstring
campaignstring object-id
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 8 revisions of this API.