public
POST /v1/public/signup
Start an in-app sign-up by mailing a confirm link.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/public/signup \
-H "Content-Type: application/json" \
-d '{ "email": <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
docs/576 §9. Unauthenticated (no permission: the person has no account yet), so it is throttled per trusted client (signup_start, 10/hour) on top of a per-address mail budget (one mail per 60 s, five per hour). ⛔ No enumeration. The answer is the same 202 whether or not the address already has an account. A known address with a password is mailed "you already have an account, sign in or reset your password"; any other address is mailed our branded link to /signup/verify?token=…, valid for 48 hours. No Keycloak user is created until the password is chosen (completeSignup). A disposable or invalid address is refused with 403 SIGNUP_EMAIL_REFUSED, the same refusal the Keycloak form path gets at its first sign-in (docs/1174). When the address looks like a mistyped domain ("gamil.com") the refusal also carries details[0] = {field: email, code: EMAIL_POSSIBLE_TYPO, suggestion} (EMAILTYPO).
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
email | string | Yes | — |
locale | string | No | The language the mail is written in and the account is created with. |
intent | string<register, trial> | No | — |
plan | string | No | The plan the person picked on the public site, carried to the dashboard. |
trial | string | No | The trial the person picked on the public site, carried to the dashboard. |
marketing_opt_out | boolean | No | Ticked "do not send me marketing email"; stored on the account. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
status | string<sent> | Yes | — |
resend_after_seconds | integer | Yes | How long the page waits before offering "Resend" again. |
Errors this endpoint can return
403 · 422 · 429 · 503