---
title: "Send proactive message"
method: POST
path: "/inbox/v1/proactive-messaging"
tags: ["Inbox"]
---

# Send proactive 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`

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

## Request body

- SendProactiveMessageRequest
  - `medium` 'WHATSAPP', required: The medium you want to use
  - `channel` string, required: The name of the channel. Use one of the Accounts in Settings -> Channels
  - `contact` string, required: The reference to a contact. In case of a telephone number it should start with a plus sign
  - `text` string, required: The message you want to send
  - `metadata` object: 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.
  - `sender` object
    - `pictureUrl` string: The url of the picture to be used as the sender's avatar.

## Response `200`

Success

- SendProactiveMessageResponse
  - `correlationId` string

## Other responses

- `400`: The request is malformed.
- `401`: Unauthorized: when using an invalid or expired access token

---

[API](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api.md) - [All operations](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/revisions/adac53bd28bb?raw)
