Messages (Bulk)

Bulk create messages

Creates a bulk batch of messages.

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

Legacy RoleEquivalent Permission Set Role
org.user.message.writeorg.permission.message.create
post/messages/bulk

Request

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

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

If true, message was automatically generated from a Kustomer workflow or auto-response feature. If set to true, this message will be excluded from reporting metrics. If false, message was created by a manual method.

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

Success

Changes

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