notifications

GET /v1/notification-phone

Text-message and WhatsApp alerts for me in this organisation.

All notifications endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/notification-phone \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Whether text messages (SMS) and WhatsApp alerts can be used here, the countries whose numbers we can text, my verified number on each channel and whether my consent is active, and the events a text can be sent for. A person only, never an API key. A white-label organisation sees both channels unavailable: texts come from Zinn®'s own sender, which would show our name to your clients.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNoThe organization to act on, as for the other notification endpoints. Omitted resolves to your own only when you belong to exactly one organisation.

Response

NameTypeRequiredWhat it is
availabilityobjectYes—
channelsobject[]Yes—
consent_text_versionstringYes—
events_by_topicobjectYes—
event_groupsobjectYes—

Errors this endpoint can return

401 · 403