messaging

Send a message

Sends a direct message to a single recipient on the specified platform.

post/v2/messages

Request body

accountIdstring required

Blotato id of the connected social account the message is sent from.

recipientIdstring required

Platform-native id of the recipient (e.g. Instagram business-scoped user id).

textstring required

Plain-text message body.

{
  "target": {
    "targetType": "facebook",
    "pageId": "123456789"
  }
}

Default Response

conversationIdstring nullable required

Parent Blotato conversation id.

createdAtstring required

direction'incoming' | 'outgoing' required

errorCodeinteger nullable required

Set only when status is failed.

errorMessagestring nullable required

Set only when status is failed.

idstring required

platform'facebook' | 'instagram' required

recipientIdstring required

senderIdstring nullable required

status'delivered' | 'failed' | 'processing' | 'queued' | 'sent' required

textstring required

Changed in 2 of the 8 revisions of this API.11

Aug 21, 202639e94457ccb210See the full diff
- ○
  added the optional property action to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property action to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property action to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property action to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property action to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
Aug 11, 202651232970f10e1See the full diff
- ○
  added the non-success response with the status 403
  response-non-success-status-added