Messages (Bulk)

Bulk batch update messages

Updates a bulk batch of messages.

Use the ids query param to update multiple messages in bulk with the same data.

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

Legacy RoleEquivalent Permission Set Role
org.user.message.writeorg.permission.message.update
put/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)

Query parameters

idsstring
Example:id1,id2

Comma-separated list of unique message IDs.

Request body

idstring required
conversationstring
externalIdstring nullable
previewstring nullable
subjectstring nullable
status'sent' | 'received' | 'error'
errorAtstring date-time
sentAtstring date-time nullable
sizenumber
metaobject
customobject
relatedstring
createdAtstring date-time
modifiedAtstring date-time
updatedAtstring date-time
createdBystring object-id
modifiedBystring object-id nullable
langstring nullable

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.