messaging

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

post/v2/messages

Request

  • Base URL
    https://backend.blotato.com
  • Auth
    API key in header blotato-api-key

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.

Example request

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

Response

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

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the non-success response with the status