Skip to main content
MessagesVersion: v3

Update message status

PUT/conversations/messages/{messageId}/status

Post the necessary fields for the API to update message status.

Authorizations

Authorizationstringheaderrequired

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

Scope:conversations/message.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

messageIdstringrequired

Message Id

Example:ve9EPM428h8vShlRW1KT

Body

statusstringrequired

Message status

Available optionsdeliveredfailedpendingread
Example:read
errorobject

Error object from the conversation provider

emailMessageIdstring

Email message Id

Example:ve9EPM428h8vShlRW1KT
recipientsstring[]

Email delivery status for additional email recipients.

Response

Created the message

conversationIdstringrequired

Conversation ID.

Example:ABC12h2F6uBrIkfXYazb
emailMessageIdstring

This contains the email message id (only for Email type). Use this ID to send inbound replies to CRM to create a threaded email.

Example:rnGyqh2F6uBrIkfhFo9A
messageIdstringrequired

This is the main Message ID

Example:t22c6DQcTDf3MjRhwf77
messageIdsstring[]

When sending via the GMB channel, we will be returning list of messageIds instead of single messageId.

msgstring

Additional response message when sending a workflow message

Example:Message queued successfully.