notifications
POST /v1/notification-phone/confirm
Confirm the code; my number is connected with every topic off.
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/confirm \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "verification_id": <string>, "code": <string> }'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
A code works once, for ten minutes, and five wrong tries spend it. On success each asked channel becomes a kind=sms or kind=whatsapp notification connection owned by me, with every topic off until I turn it on.
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 |
|---|---|---|---|
verification_id | string | Yes | — |
code | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
availability | object | Yes | — |
channels | object[] | Yes | — |
consent_text_version | string | Yes | — |
events_by_topic | object | Yes | — |
event_groups | object | Yes | — |
Errors this endpoint can return
401 · 403 · 422 · 429