Kustomer

Links

Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create a Conversation

Creates a new conversation.

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

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.conversation.write|org.permission.conversation.create|

Custom Attributes

Custom attributes are optional and allow you to specify custom key value pairs. They follow a convention which allows us to specify the field data type with a name suffix:

Suffix
  • Num or null
  • At or null
  • Str or null, length: [ 0 .. 1024 ] characters
  • Txt or null, length: [ 0 .. 1024 ] characters
  • Bool or null
  • Url or null, format:

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.

Input

type: object properties: data: type: string example: >- "{\n \"customer\": \"<object-id>\",\n \"id\": \"<object-id>\",\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"priority\": \"<integer>\",\n \"createdAt\": \"<dateTime>\",\n \"importedAt\": \"<dateTime>\",\n \"direction\": \"<string>\",\n \"replyChannel\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"assignedUsers\": [\n \"<object-id>\"\n ],\n \"assignedTeams\": [\n \"<object-id>\"\n ],\n \"custom\": \"<object>\",\n \"defaultLang\": \"<string>\",\n \"queue\": {}\n}" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string channels: type: string status: type: string messageCount: type: string noteCount: type: string satisfaction: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string tags: type: string suggestedTags: type: string sentiment: type: string lastMessageIn: type: string assignedUsers: type: string assignedTeams: type: string firstResponse: type: string direction: type: string outboundMessageCount: type: string rev: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string customer: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string messages: type: object properties: links: type: object properties: self: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string