API ReferenceInboxesMessages

Update Message

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
ID of inbox.
message_idstringRequired
ID of message.

Request

This endpoint expects an object.
add_labelslist of stringsOptional
Labels to add to message.
remove_labelslist of stringsOptional
Labels to remove from message.

Response

This endpoint returns an object.
inbox_idstring
ID of inbox.
thread_idstring
ID of thread.
message_idstring
ID of message.
labelslist of strings
Labels of message.
timestampdatetime
Time at which message was sent or drafted.
fromstring

Address of sender. In format username@domain.com or Display Name <username@domain.com>.

tolist of strings

Addresses of recipients. In format username@domain.com or Display Name <username@domain.com>.

sizeinteger
Size of message in bytes.
updated_atdatetime
Time at which message was last updated.
created_atdatetime
Time at which message was created.
reply_tolist of strings or null

Reply-to addresses. In format username@domain.com or Display Name <username@domain.com>.

cclist of strings or null

Addresses of CC recipients. In format username@domain.com or Display Name <username@domain.com>.

bcclist of strings or null

Addresses of BCC recipients. In format username@domain.com or Display Name <username@domain.com>.

subjectstring or null
Subject of message.
previewstring or null
Text preview of message.
textstring or null
Plain text body of message.
htmlstring or null
HTML body of message.
extracted_textstring or null
Extracted new text content.
extracted_htmlstring or null
Extracted new HTML content.
attachmentslist of objects or null
Attachments in message.
in_reply_tostring or null
ID of message being replied to.
referenceslist of strings or null
IDs of previous messages in thread.

Errors