Hootsuite Proactive Messaging Rest API
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.### Examples1. Send a proactive text messageThe following example shows a proactive outbound message that can be sent as a text message. Inbox 2.0 supports text messaging on WhatsAppEnterprises are responsible for ensuring that the customers have opted-in for proactive communications.Request```shellcurl -X POST https://platform.hootsuite.com/inbox/v1/proactive-messaging/ \ -H 'Authorization: Bearer ' \ -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: Enterprises construct the messages in shorthand and send it in the text field as shown in the following code.Request```shellcurl -X POST https://platform.hootsuite.com/inbox/v1/proactive-messaging/ \ -H 'Authorization: Bearer ' \ -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 overviewRequest```shellcurl -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 detailsRequest```shellcurl -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" }]```
Hootsuite Proactive Messaging Rest API is one of 21 APIs that Hootsuite publishes on the 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.
This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://platform.hootsuite.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Hootsuite Proactive Messaging Rest API declares
4 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearer-token).
It accepts HTTP basic authentication (basic-auth).
It supports OAuth 2.0 (Oauth2ClientCredentials) using the clientCredentials flow, exposing 1 scope.
An API key is passed in the header as X-Hootsuite-Signature (SharedSecret).
By default, every request must be authenticated.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
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…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SendProactiveMessageRequest (6 properties), StatusOverviewResponse (3 properties), ErrorResponse (1 property), SendProactiveMessageResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hootsuite 12
Other APIs Hootsuite publishes across the network.
This is an independent, third-party profile of Hootsuite Proactive Messaging Rest API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.