Invite a person to the organization
Creates a pending invitation (role capped at admin/member) and emails the invitee a redemption link. Requires an Idempotency-Key header (the email is an irreversible side effect): a retry with the same key replays the original result for 24h instead of emailing again. The token is never returned.
Creates a pending invitation (role capped at admin/member) and emails the invitee a redemption link. Requires an Idempotency-Key header (the email is an irreversible side effect): a retry with the same key replays the original result for 24h instead of emailing again. The token is never returned.
Authorization
bearerAuth invitations:createA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: invitations:create
Header Parameters
Required — this write has an irreversible side effect. Send a unique key per logical operation; a retry with the same key replays the original success for 14 days instead of re-running it. Reusing a key with a different body returns 400. Omitting the header returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Invite a person to the organization by email.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "email": "string", "role": "owner", "status": "pending", "expires_at": "string", "created_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}