Invite someone by email
Requires invitation:create, and being an owner to invite an owner. Emails the invited address a single-use link to accept the invitation in the console.
POST
/organizations/{organizationId}/invitationsAuthorization
AuthorizationBearer token (JWT) · headerrequiredAn access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.
Path parameters
organizationIdstring<uuid>requiredRequest body
requiredapplication/jsonemailstring<email>requiredrolestringrequiredName of an organization Role, such as owner, admin or member. Inviting an owner requires being an owner.
Responses
201
The invitation was created and emailed.
idstring<uuid>requiredemailstringrequiredrolestringrequiredcreated_atstring<date-time>requiredexpires_atstring<date-time>requireddefault
The request failed.
errorstringrequiredStable machine-readable code.
Allowed:
invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternalmessagestringrequiredHuman-readable explanation.