HOhootsuite
Inbox

Send proactive message

The message is queued for processing. Use the returned correlation id to get the status of the sent message.

post/inbox/v1/proactive-messaging

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/inbox/v1/proactive-messaging
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Request body

medium'WHATSAPP' required

The medium you want to use

channelstring required

The name of the channel. Use one of the Accounts in Settings -> Channels

contactstring required

The reference to a contact. In case of a telephone number it should start with a plus sign

textstring required

The message you want to send

metadataobject

When sending a proactive message, you can pass along custom information that is stored in Inbox 2.0. This data can then be exported. Please contact dev.support@hootsuite.com to add metadata to the Messages export. For example, when you send an appointment confirmation to your customer, you can pass along a unique identifier. You can then download the Messages export from Inbox 2.0, and determine how many unique customers are responding to your outbound notification.

Example request

{
  "metadata": {
    "myReference": "19758293529351"
  },
  "sender": {
    "pictureUrl": "https://example.com/my-picture.png"
  }
}

Response

Success

correlationIdstring

Example response

{
  "correlationId": "4f1dba7b-9ef3-11e8-a0f4-175408e41992"
}

Changes

No recorded changes to this operation across all 1 revision of this API.