Skip to content
PaalChat Docs

Send notification

.md
POST
https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/notifications

Token ability: messages.send ยท Authentication

One notification, tried on channels in order (default whatsapp, sms, email) until one takes it. A channel is passed over when there is no content or address for it, the business has not set it up, its provider is unavailable, or the send is refused (opted out, suppressed...). If its message later fails, the next channel is tried. A message whose fate is unknown never triggers the next channel - it may already have arrived. Addresses come from to, or from the contact (contact_id). Same reference, same notification.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

Body parameters

channels array of strings
contact_id integer | null
to object | null
whatsapp string to.whatsapp
sms string to.sms
email string to.email
whatsapp object | null
template object whatsapp.template

Name, language and components - as on Send message.

sms object | null
text string sms.text

Max 918 characters.

email object | null
subject string email.subject
text string email.text
reference string | null

Max 150 characters.

category string | null

One of: marketing, notifications, transactional, ``.

topic string | null
urgent boolean

Responses

200

Duplicate reference - the original notification.

202

Accepted; on its first usable channel.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

422

validation_failed - fields are invalid; see errors.

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.