Update message status

PUT 
/conversations/messages/:messageId/status

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

Request

Version stringrequired

API Version

Available optionsv3

messageId stringrequired

Message Id

application/json

application/json

Body

Bodyrequired

statusstringrequired
Message status
Available optionsdeliveredfailedpendingread
errorobject

Error object from the conversation provider

emailMessageIdstring

Email message Id

recipientsstring[]

Email delivery status for additional email recipients.

Example (auto)

{
  "status": "read",
  "error": {
    "code": "1",
    "type": "saas",
    "message": "There was an error from the provider"
  },
  "emailMessageId": "ve9EPM428h8vShlRW1KT",
  "recipients": [
    "string"
  ]
}

application/json

Created the message

application/json

Schema

Schema

conversationIdstringrequired

Conversation ID.

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.

messageIdstringrequired

This is the main Message ID

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 (auto)

{
  "conversationId": "ABC12h2F6uBrIkfXYazb",
  "emailMessageId": "rnGyqh2F6uBrIkfhFo9A",
  "messageId": "t22c6DQcTDf3MjRhwf77",
  "messageIds": [
    "string"
  ],
  "msg": "Message queued successfully."
}