Theme switcher

Update Message

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Empty value:
True
Authorizationstring

Path Parameters

message_idstring Required

Body Parameters

message_idstring

The unique identifier for the message.

subjectstring

The subject line or title of the message.

Nullable:
True
contentstring

The body content of the message.

Nullable:
True
created_datestring

The timestamp when the message was created.

readboolean

Indicates whether the message has been marked as read by the receiver.

Default value
false
acknowledged_datestring

The timestamp when the message was acknowledged by the receiver, if applicable.

Nullable:
True
archivedboolean

Indicates whether the message has been archived.

Default value
false
favoriteboolean

Indicates whether the message is marked as a favorite

Default value
false
senderstring

The identifier or name of the message sender.

Nullable:
True
receiverstring

The identifier or name of the message receiver.

Nullable:
True
documentsarray

A list of Document objects attached to this message. Each document includes a document_id that can be used with the corresponding reporting or document service to download the file contents.

Nullable:
True

Show child attributes

Response

200
Object
OK
400
Object
Bad Request

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
401
Object
Unauthorized

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
404
Object
Not Found

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
500
Object
Internal Server Error
default
Object
Unexpected error

Response Attributes

typestring
Nullable:
True
titlestring
Nullable:
True
statusinteger
Nullable:
True
detailstring
Nullable:
True
instancestring
Nullable:
True
Was this section helpful?

PUT

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot