notifications
POST /v1/notification-phone/start
Text a six-digit code to my number.
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 POST https://api.zinndigital.com/v1/notification-phone/start \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "phone": <string>, "channels": <string<sms, whatsapp>[]>, "consent": <boolean> }'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
Sends one code to the number by text message (and on WhatsApp when only WhatsApp is asked for). consent must be true: it records that I agreed to receive alert texts on this number (the wording version is consent_text_version). Refused when the channel is unavailable, the number's country is not open, the organisation is white-label or not in good standing, or too many codes were asked for (429). No topic is switched on by this: every topic stays off for texts until I turn it on in the routing grid. A +1 (US/Canada) number is single opt-in: no code is sent; the number is connected at once, one confirmation text is sent, and confirmed is true (skip the confirm step). A +1 number is texted only account notices (payments, orders, mail DNS action needed); its connection carries us_ca_limited.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | The organization to act on, as above. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
phone | string | Yes | The mobile number in international form, e.g. +447700900123. |
channels | string<sms, whatsapp>[] | Yes | — |
consent | boolean | Yes | The consent tick. Must be true. |
locale | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
verification_id | string | Yes | — |
expires_at | string | Yes | — |
confirmed | boolean | Yes | True for a +1 number (single opt-in): it is already connected, there is no code to confirm. |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503