Customers (Messages)
Messages

Create message by customer ID

Creates a new message based on the unique customer ID.

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

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

Note

If a conversation is specified, the message will be linked to the existing conversation. Otherwise, a new conversation will be created and associated with the message.

Authorization

The 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.

post/customers/{id}/messages

Request

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

Path parameters

idstring required
Example:57c08ccde595371400462df2

Unique ID of the customer.

Request body

idstring object-id
externalIdstring
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

No recorded changes to this operation across all 8 revisions of this API.