compute
POST /v1/compute/eligibility/verify-email
Email the caller a link that verifies their address.
Authentication
Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.
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/compute/eligibility/verify-email \
-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
Sends the signed-in person a fresh verification link, so they can clear the verified-email step before their first server. ⛔ Only to the caller, and only when the caller is an owner of the organisation whose address is not yet verified — the step asks for an owner's address, and mailing anybody else from this button would be a way to spam any member. At most three links an hour per person (422 beyond that). 503 when the email could not be sent. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
sent | boolean | Yes | — |
email | string | Yes | The address the link was sent to. |
Errors this endpoint can return
401 · 403 · 422 · 429 · 503