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. writeAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
messageIdstringrequired
Message Id
Example:
ve9EPM428h8vShlRW1KTBody
statusstringrequired
Message status
Available options
deliveredfailedpendingreadExample:
readerrorobject
Error object from the conversation provider
emailMessageIdstring
Email message Id
Example:
ve9EPM428h8vShlRW1KTrecipientsstring[]
Email delivery status for additional email recipients.
Response
Created the message
conversationIdstringrequired
Conversation ID.
Example:
ABC12h2F6uBrIkfXYazbemailMessageIdstring
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:
rnGyqh2F6uBrIkfhFo9AmessageIdstringrequired
This is the main Message ID
Example:
t22c6DQcTDf3MjRhwf77messageIdsstring[]
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.