Conversations (Messages)
Messages

Create message from conversation

Changed on

Creates a new message from a conversation.

NOTE

The new message created by the endpoint will be associated with the same customer as the conversation.

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

Legacy RoleEquivalent Permission Set Role
org.user.message.writeorg.permission.message.create

Authorization

org.admin role is required for setting createdAt, createdBy, modifiedAt, and modifiedBy. Otherwise, the token automatically sets these attributes.

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.

post/conversations/{id}/messages

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/conversations/{id}/messages
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:58288a637c7f551a00b5b716

Unique ID of the conversation.

Request body

idstring object-id
externalIdstring
customerstring object-id
conversationstring object-id
channel'email' | 'sms' | 'chat' | 'facebook' | 'twitter-dm' | 'twitter-tweet' | 'voice' | 'instagram' | 'whatsapp' required
previewstring
subjectstring
direction'in' | 'out'
appstring required
sizenumber
relatedstring
status'sent' | 'received' | 'error'
errorAtstring date-time
autoboolean
sentAtstring date-time
source'bulk' | 'satisfaction'
shortcutsstring[]
kbArticlesstring[]
metaobject
customobject
createdAtstring date-time
modifiedAtstring date-time
createdBystring object-id
modifiedBystring object-id
importedAtstring date-time
langstring nullable

Response

Created

Changes

  • 92258c5f2333Revision changes
    • info

      api operation id CreateMessagefromConversation removed and replaced with CreateMessageFromConversation