Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Bulk Batch Update Messages
Updates a bulk batch of messages.
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.message.write|org.permission.message.update|
Input
type: object
properties:
data:
type: string
example: >-
"[\n {\n \"id\": \"<string>\",\n \"conversation\":
\"<string>\",\n \"externalId\": \"<string>\",\n \"preview\":
\"<string>\",\n \"subject\": \"<string>\",\n \"status\":
\"<string>\",\n \"error\": {\n \"status\":
\"<number>\",\n \"code\": \"<string>\",\n \"title\":
\"<string>\",\n \"detail\": \"<string>\",\n
\"source\": \"<object>\",\n \"meta\":
\"<object>\",\n \"links\": \"<object>\"\n },\n
\"errorAt\": \"<dateTime>\",\n \"sentAt\": \"<dateTime>\",\n
\"size\": \"<number>\",\n \"attachments\": [\n
{\n \"_id\": \"<object-id>\",\n \"name\":
\"<string>\",\n \"contentType\":
\"<string>\",\n \"contentLength\":
\"<number>\",\n \"sourceId\": \"<object-id>\"\n
}\n ],\n \"meta\": \"<object>\",\n \"custom\":
\"<object>\",\n \"related\": \"<string>\",\n \"sentiment\":
{\n \"polarity\": \"<number>\",\n \"confidence\":
\"<number>\"\n },\n \"createdAt\": \"<dateTime>\",\n
\"modifiedAt\": \"<dateTime>\",\n \"updatedAt\":
\"<dateTime>\",\n \"createdBy\": \"<object-id>\",\n
\"modifiedBy\": \"<object-id>\",\n \"lang\": \"<string>\"\n
},\n {\n \"id\": \"<string>\",\n \"conversation\":
\"<string>\",\n \"externalId\": \"<string>\",\n \"preview\":
\"<string>\",\n \"subject\": \"<string>\",\n \"status\":
\"<string>\",\n \"error\": {\n \"status\":
\"<number>\",\n \"code\": \"<string>\",\n \"title\":
\"<string>\",\n \"detail\": \"<string>\",\n
\"source\": \"<object>\",\n \"meta\":
\"<object>\",\n \"links\": \"<object>\"\n },\n
\"errorAt\": \"<dateTime>\",\n \"sentAt\": \"<dateTime>\",\n
\"size\": \"<number>\",\n \"attachments\": [\n
{\n \"_id\": \"<object-id>\",\n \"name\":
\"<string>\",\n \"contentType\":
\"<string>\",\n \"contentLength\":
\"<number>\",\n \"sourceId\": \"<object-id>\"\n
}\n ],\n \"meta\": \"<object>\",\n \"custom\":
\"<object>\",\n \"related\": \"<string>\",\n \"sentiment\":
{\n \"polarity\": \"<number>\",\n \"confidence\":
\"<number>\"\n },\n \"createdAt\": \"<dateTime>\",\n
\"modifiedAt\": \"<dateTime>\",\n \"updatedAt\":
\"<dateTime>\",\n \"createdBy\": \"<object-id>\",\n
\"modifiedBy\": \"<object-id>\",\n \"lang\": \"<string>\"\n
}\n]"
title: Data
Output
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
ids:
type: string
context:
type: string
status:
type: string
v2:
type: string
payload:
type: object
properties:
api:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
custom:
type: object
properties:
foobar:
type: string
path:
type: string
user:
type: object
properties:
id:
type: string
userType:
type: string
roles:
type: array
items:
type: string
orgName:
type: string
subject:
type: string
org:
type: string
requestId:
type: string
service:
type: string
method:
type: string
createdAt:
type: string
updatedAt:
type: string
completed:
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
createdBy:
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