POST`/v1/tenant_invitations`

tenant_invitations.create

Issues a new invitation and emails the recipient an accept link. The plaintext invite token is generated server-side, sent ONLY in the email body and accept URL, and never returned in the API response — the database stores only the SHA-256 hash. Default expiry is 7 days. If the email send fails after the row is created, returns 502 with the new invitation id; the caller can retry via the `/resend` endpoint without creating a duplicate row.

Parameters

Name	Type	Required	Description
Idempotency-Key	string	optional	Optional client-supplied key for at-most-once semantics. The first request with a given key is processed; subsequent requests with the same key replay the cached response for 24h.

Request body

No parameters.

Response

No parameters.

Examples

curl -sS -X POST \
  -H "Authorization: Bearer $CULPRIT_API_TOKEN" \
  -H "content-type: application/json" \
  -d '{ /* … */ }' \
  https://api.theculprit.ai/v1/tenant_invitations

Try it

Bearer token

Stored locally in your browser at localStorage.docs.tryit.token. Never sent to Culprit's analytics. Use a read-only token.

Request body (JSON)