githubEdit

Notifications

Notifications use pre-approved templates to send one-way messages to users.


circle-exclamation

Send Notification

Use this endpoint to send a WhatsApp template message to a single recipient.

POST https://www.channel360.co.za/v1.1/org/{{orgId}}/notification

Headers

Name
Value

Content-type

applications/json

Authorization

Bearer <token>

Body

orgId

stringrequired

Organization ID (path parameter)

destination

stringrequired

Recipient phone number

message

objectrequired

Message payload (template-based)

message.type

stringrequired

Must be set to template

message.template

objectrequired

Template message definition

message.template.name

stringrequired

The name of the template.

message.template.language

objectrequired

An object specifying the language for the template with the following properties:

message.template.language.policy

stringrequired

Set to "deterministic" to define the language policy.

message.template.language.code

stringrequired

Language code (e.g. en_US)

message.template.components

array

An array of message components. You can define message components within this array.

Examples of templates and notifications

Example 1: Notification sent using a basic text template.

Example 2: Notification sent using a template with header tag, body tag, footer text, and button tag.

Example 3: Notification sent using an Afrikaans template.

What happens after sending?

When you send a notification, the API responds with a notificationId.

circle-exclamation

Authentication Templates

For authentication message templates, the components array contains dynamic placeholders that must be populated with a unique {{AUTH_CODE}} at runtime. These placeholders ensure secure and personalised message delivery.

  • The {{AUTH_CODE}} should be inserted into the parameters section dynamically before sending.

  • The same {{AUTH_CODE}} should be used across all relevant components (e.g., body text and buttons).

Override API

triangle-exclamation

Message overrides (also referred to as passthrough) are a way to access newer META features that are not yet fully supported by C360.

To use the override feature, you need to include an "override" object that will contain your usual payload fields instead of the message object. Here is an example:

Last updated

Was this helpful?