Back to KustomerCreate a Message from Conversation
Creates a new message from a conversation.
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|
NOTE
Using this endpoint will result in a new message that will be associated with the same customer as the conversation.
Authorization
org.admin
role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, these attributes are automatically set by the token.
Rate Limit
Messages are subject to a rate limit. A single client can create up to 120 messages per minute per customer.
Messages 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:
parameters:
type: object
properties:
id:
type: string
description: (Required) Unique ID of the conversation.
required:
- id
title: Parameters
data:
type: string
example: >-
"{\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}"
title: Data
Output
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
channel:
type: string
app:
type: string
size:
type: string
direction:
type: string
meta:
type: string
status:
type: string
sentAt:
type: string
createdAt:
type: string
updatedAt:
type: string
modifiedAt:
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
modifiedBy:
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
conversation:
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