Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Update Conversation Attributes
Updates a conversation's attributes using its unique ID.
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.conversation.write|org.permission.conversation.update|
Note
This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single Conversation. Please see the API Rate Limiting section of the documentation for additional details.
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
Numor null Ator null Stror null, length: [ 0 .. 1024 ] characters Txtor null, length: [ 0 .. 1024 ] characters Boolor null Urlor null, format:
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: (Required) ID of the conversation.
required:
- id
title: Parameters
data:
type: string
example: >-
"{\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n
\"direction\": \"<string>\",\n \"priority\": \"<integer>\",\n
\"satisfaction\": \"<number>\",\n \"satisfactionLevel\": {\n
\"createdAt\": \"<dateTime>\",\n \"status\": \"<string>\",\n
\"form\": \"<object-id>\",\n \"formResponse\":
\"<object-id>\",\n \"updatedAt\": \"<dateTime>\",\n
\"scheduledFor\": \"<dateTime>\",\n \"firstAnswer\":
\"<string>\",\n \"sentAt\": \"<dateTime>\",\n \"score\":
\"<number>\",\n \"rating\": \"<integer>\",\n \"channel\":
\"<string>\",\n \"sentBy\": \"<object-id>\",\n
\"sentByTeams\": [\n \"<object-id>\",\n
\"<object-id>\"\n ]\n },\n \"suggestedShortcuts\": [\n
{\n \"shortcutId\": \"<string>\",\n \"confidence\":
\"<number>\"\n },\n {\n \"shortcutId\":
\"<string>\",\n \"confidence\": \"<number>\"\n }\n
],\n \"status\": \"<string>\",\n \"replyChannel\":
\"<string>\",\n \"subStatus\": \"<object-id>\",\n \"snooze\":
{\n \"status\": \"<string>\",\n \"time\":
\"<dateTime>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n
\"suggestedTags\": [\n {\n \"tag\":
\"<string>\",\n \"confidence\": \"<number>\"\n }\n
],\n \"sentiment\": {\n \"polarity\": \"<number>\",\n
\"confidence\": \"<number>\"\n },\n \"assignedUsers\": [\n
\"<object-id>\"\n ],\n \"assignedTeams\": [\n
\"<object-id>\"\n ],\n \"custom\": \"<object>\",\n \"deleted\":
\"<boolean>\",\n \"ended\": \"<boolean>\",\n \"endedAt\":
\"<dateTime>\",\n \"endedReason\": \"<string>\",\n \"endedBy\":
\"<object-id>\",\n \"endedByType\": \"<string>\",\n \"locked\":
\"<boolean>\",\n \"rev\": \"<number>\",\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
externalQueue:
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