Sign in
Messages

Update message by ID

Updates a message based on the unique message ID.

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

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

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single message. To learn more, see Rate limiting.

Authorization

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

Custom Attributes

Custom attributes are optional and allow you to specify custom key-value pairs.

Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

Naming Suffix

  • Num number or null
  • At date-time or null
  • Str string or null, length: [ 0 .. 1024 ] characters
  • Txt string or null, length: [ 0 .. 1024 ] characters
  • Bool boolean or null
  • Url string or null, format: uri
put/messages/{id}

Request

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

Query parameters

replaceboolean
Example:true

Set to true to update the document. Otherwise, performs the same update as a PATCH request. Default value: false.

Request body

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
spamboolean
modifiedBystring object-id nullable
langstring nullable

Response

OK

Changes

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