# Hootsuite Proactive Messaging Rest API

**Canonical:** https://apis.io/apis/hootsuite/hootsuite-proactive-messaging-rest-api-api/  
**Provider:** Hootsuite — https://apis.io/providers/hootsuite/  
**Base URL:** https://platform.hootsuite.com/v1  
**Documentation:** https://developer.hootsuite.com/docs/api-overview

Hootsuite Proactive Messaging Rest API is one of 21 APIs that [Hootsuite](https://apis.io/providers/hootsuite/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

When calling the Proactive Messaging API, the client needs to be authenticated. The [REST API authentication](#tag/rest-api-authentication) section contains more details on how to authenticate your client. ### Examples 1. Send a proactive text message The following example shows a proactive outbound message that can be sent as a text message. Inbox 2.0 supports text messaging on WhatsApp Enterprises are responsible for ensuring that the customers have opted-in for proactive communications. Request ```shell curl -X POST https://platform.hootsuite.com/inbox/v1/proactive-messaging/ \ -H 'Authorization: Bearer <token>' \ -H 'Content-Type: application/json' \ -d '{ "medium": "WHATSAPP", "channel": "myChannel", "contact": "+32495123456", "text": "Hello world!" }' ``` Response `200` ```json { "correlationId": "3a7c6c1d-9f9b-11e8-b23b-6f13d5844b66" } ``` 2. Send a proactive message template (WhatsApp) WhatsApp allows for proactive outbound communication when these are sent as message templates that have been authorized by WhatsApp. These templates have a name, corresponding text, and substitution parameters within the text to make them personalized. Inbox 2.0 has simplified how enterprises can send out these message templates through the use of shorthand codes for inline syntax: ```text &((namespace=[[NAMESPACE]] template=[[TEMPLATE NAME]] fallback=[[FALLBACK TEXT]] language=[[LANGUAGE]] body_text=[[VARIABLE1]] body_text=[[VARIABLE2]]))& ``` | Parameter name | Parameter description | Required | |----------------|----------------------------------------------------------------------------------------------------------------------------|-----------| | namespace | Unique code provided by WhatsApp while defining message templates. | true | | template | Name of the template provided on WhatsApp Manager. | true | | fallback | We recommend setting the same value as the Template name here. | true | | language | The language in which the messages should be sent. The language needs to be defined in the WhatsApp Manager. | true | | body_text | The variable text. 0, 1, or multiple variables in a message. Per variable, there needs to be a body_text parameter. | true | The language codes can be found on: <https://developers.facebook.com/docs/whatsapp/message-templates/creation> Enterprises construct the messages in shorthand and send it in the text field as shown in the following code. Request ```shell curl -X POST https://platform.hootsuite.com/inbox/v1/proactive-messaging/ \ -H 'Authorization: Bearer <token>' \ -H 'Content-Type: application/json' \ -d '{ "medium": "WHATSAPP", "channel": "myChannel", "contact": "+32495123456", "text": "&((namespace=[[3c860f8b_1ae3_1105_b9ea_647e69aa2d49]] template=[[welcome_customer]] fallback=[[welcome_customer]] language=[[en]] body_text=[[Gregory]] body_text=[[How can I help you?]]))&" }' ``` Response `200` ```json { "correlationId": "3a7c6c1d-9f9b-11e8-b23b-6f13d5844b66" } ``` 3. Get status overview Request ```shell curl -X GET https://platform.hootsuite.com/inbox/v1/proactive-messaging/3a7c6c1d-9f9b-11e8-b23b-6f13d5844b66 \ -H 'Authorization: Bearer ' ``` Response `200` ```json { "correlationId": "3a7c6c1d-9f9b-11e8-b23b-6f13d5844b66", "total": 1, "statuses": { "SENT": 1 } } ``` 4. Get status details Request ```shell curl -X GET https://platform.hootsuite.com/inbox/v1/proactive-messaging/f988bd0f-9f9d-11e8-b23b-7d351b0c7ce9/FAILED \ -H 'Authorization: Bearer ' ``` Response 200 ```json [ { "status": "FAILED", "contact": "+32495123456", "reason": "No channel found for medium TWIT" } ] ```

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| POST | `/inbox/v1/proactive-messaging` | Send proactive message |
| GET | `/inbox/v1/proactive-messaging/{correlationId}` | Get status |
| GET | `/inbox/v1/proactive-messaging/{correlationId}/{status}` | Get status detail |

## Machine-readable artifacts (19)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/openapi/hootsuite-proactive-messaging-rest-api-api-openapi.yml
- **Documentation** — https://developer.hootsuite.com/docs/api-overview
- **APIReference** — https://apidocs.hootsuite.com/docs/api/index.html
- **GettingStarted** — https://developer.hootsuite.com/docs/getting-started-with-the-rest-api
- **Authentication** — https://developer.hootsuite.com/docs/api-authentication
- **OAuth 2.0** — https://developer.hootsuite.com/docs/enabling-oauth-20
- **Postman** — https://app.getpostman.com/run-collection/eeda0fcdf55ea26bd0ec
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/asyncapi/hootsuite-webhooks.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/rate-limits/hootsuite-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/errors/hootsuite-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/data-model/hootsuite-data-model.yml
- **Documentation** — https://developer.hootsuite.com/docs/analytics-overview
- **APIReference** — https://apidocs.hootsuite.com/docs/api/analytics/index.html
- **GettingStarted** — https://developer.hootsuite.com/docs/using-the-api
- **OAuthScopes** — https://raw.githubusercontent.com/api-evangelist/hootsuite/refs/heads/main/scopes/hootsuite-scopes.yml
- **Documentation** — https://developer.hootsuite.com/docs/inbox-overview
- **APIReference** — https://apidocs.hootsuite.com/docs/api/inbox/index.html
- **Documentation** — https://developer.hootsuite.com/docs/amplify-overview
- **APIReference** — https://amplify.hootsuite.com/api-docs

## Other Hootsuite APIs (12)

- [Hootsuite Developer Documentation MCP](https://apis.io/apis/hootsuite/mcp/)
- [Hootsuite Analytics API](https://apis.io/apis/hootsuite/hootsuite-analytics-api-api/)
- [Hootsuite Authentication API](https://apis.io/apis/hootsuite/hootsuite-authentication-api/)
- [Hootsuite Comments API](https://apis.io/apis/hootsuite/hootsuite-comments-api/)
- [Hootsuite CRM Rest API](https://apis.io/apis/hootsuite/hootsuite-crm-rest-api-api/)
- [Hootsuite CRM Webhooks API](https://apis.io/apis/hootsuite/hootsuite-crm-webhooks-api/)
- [Hootsuite Me API](https://apis.io/apis/hootsuite/hootsuite-me-api/)
- [Hootsuite Media API](https://apis.io/apis/hootsuite/hootsuite-media-api/)
- [Hootsuite Members API](https://apis.io/apis/hootsuite/hootsuite-members-api/)
- [Hootsuite Messages API](https://apis.io/apis/hootsuite/hootsuite-messages-api/)
- [Hootsuite Organizations API](https://apis.io/apis/hootsuite/hootsuite-organizations-api/)
- [Hootsuite Queue Rest API](https://apis.io/apis/hootsuite/hootsuite-queue-rest-api-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hootsuite/hootsuite-proactive-messaging-rest-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hootsuite/.