Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Bulk Create Messages
Creates a bulk message.
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.message.write|org.permission.message.create|
Input
type: object
properties:
data:
type: string
example: >-
"[\n {\n \"channel\": \"<string>\",\n \"app\":
\"<string>\",\n \"id\": \"<object-id>\",\n \"externalId\":
\"<string>\",\n \"customer\": \"<object-id>\",\n
\"conversation\": \"<object-id>\",\n \"reference\": {\n
\"message\": \"<object-id>\",\n \"type\": \"<string>\"\n
},\n \"preview\": \"<string>\",\n \"subject\":
\"<string>\",\n \"direction\": \"<string>\",\n \"size\":
\"<number>\",\n \"related\": \"<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 \"auto\": \"<boolean>\",\n
\"sentAt\": \"<dateTime>\",\n \"source\": \"<string>\",\n
\"shortcuts\": [\n \"<object-id>\",\n
\"<object-id>\"\n ],\n \"kbArticles\": [\n
\"<object-id>\",\n \"<object-id>\"\n ],\n
\"attachments\": [\n {\n \"_id\":
\"<object-id>\",\n \"name\": \"<string>\",\n
\"contentType\": \"<string>\",\n \"contentLength\":
\"<number>\",\n \"sourceId\": \"<object-id>\"\n
}\n ],\n \"location\": {\n \"name\":
\"<string>\",\n \"address\": \"<string>\",\n
\"address2\": \"<string>\",\n \"address3\":
\"<string>\",\n \"latitude\": \"<number>\",\n
\"longitude\": \"<number>\",\n \"countryCode\":
\"<string>\",\n \"countryName\": \"<string>\",\n
\"regionCode\": \"<string>\",\n \"regionName\":
\"<string>\",\n \"cityName\": \"<string>\",\n
\"zipCode\": \"<string>\",\n \"areaCode\":
\"<string>\"\n },\n \"meta\": \"<object>\",\n
\"custom\": \"<object>\",\n \"sentiment\": {\n
\"polarity\": \"<number>\",\n \"confidence\":
\"<number>\"\n },\n \"createdAt\": \"<dateTime>\",\n
\"modifiedAt\": \"<dateTime>\",\n \"createdBy\":
\"<object-id>\",\n \"modifiedBy\": \"<object-id>\",\n
\"importedAt\": \"<dateTime>\",\n \"lang\": \"<string>\",\n
\"queue\": {}\n },\n {\n \"channel\": \"<string>\",\n
\"app\": \"<string>\",\n \"id\": \"<object-id>\",\n
\"externalId\": \"<string>\",\n \"customer\":
\"<object-id>\",\n \"conversation\": \"<object-id>\",\n
\"reference\": {\n \"message\": \"<object-id>\",\n
\"type\": \"<string>\"\n },\n \"preview\":
\"<string>\",\n \"subject\": \"<string>\",\n \"direction\":
\"<string>\",\n \"size\": \"<number>\",\n \"related\":
\"<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
\"auto\": \"<boolean>\",\n \"sentAt\": \"<dateTime>\",\n
\"source\": \"<string>\",\n \"shortcuts\": [\n
\"<object-id>\",\n \"<object-id>\"\n ],\n
\"kbArticles\": [\n \"<object-id>\",\n
\"<object-id>\"\n ],\n \"attachments\": [\n
{\n \"_id\": \"<object-id>\",\n \"name\":
\"<string>\",\n \"contentType\":
\"<string>\",\n \"contentLength\":
\"<number>\",\n \"sourceId\": \"<object-id>\"\n
}\n ],\n \"location\": {\n \"name\":
\"<string>\",\n \"address\": \"<string>\",\n
\"address2\": \"<string>\",\n \"address3\":
\"<string>\",\n \"latitude\": \"<number>\",\n
\"longitude\": \"<number>\",\n \"countryCode\":
\"<string>\",\n \"countryName\": \"<string>\",\n
\"regionCode\": \"<string>\",\n \"regionName\":
\"<string>\",\n \"cityName\": \"<string>\",\n
\"zipCode\": \"<string>\",\n \"areaCode\":
\"<string>\"\n },\n \"meta\": \"<object>\",\n
\"custom\": \"<object>\",\n \"sentiment\": {\n
\"polarity\": \"<number>\",\n \"confidence\":
\"<number>\"\n },\n \"createdAt\": \"<dateTime>\",\n
\"modifiedAt\": \"<dateTime>\",\n \"createdBy\":
\"<object-id>\",\n \"modifiedBy\": \"<object-id>\",\n
\"importedAt\": \"<dateTime>\",\n \"lang\": \"<string>\",\n
\"queue\": {}\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
app:
type: string
channel:
type: string
preview:
type: string
subject:
type: string
size:
type: string
createdAt:
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