Docs
Sign in

Invite an address to sign up.

Creates a Clerk invitation (Clerk emails the person a sign-up link to KOIDOG_INVITE_REDIRECT_URL) and marks the request invited on the koidog-site list.

POST/api/v1/invites

Scopeapprove

An address that already has a pending or accepted invitation answers that one with sent: false and nothing is sent. A list that could not be marked answers marked: false and the reason; the invitation stands. Records invite.sent with who sent it. 422 for an address the koi.dog form would not take; 409 not_configured and 502 as for the list. When an API key calls it, the timeline records who did what and the outcome. No path or query parameters.

Headers.

Idempotency-Keystring

Makes a retry safe: the same key with the same request returns the first answer and does nothing else.

Body.

emailstringrequired

The address to invite. Clerk emails it a sign-up link; 422 for an address the koi.dog invite form would not take. 1 to 254 characters.

Response.

200 OK: a JSON object. The example has placeholder values.

422 validation_failed
The body does not match its schema; each problem is in details.