Sign in
Invitations

Invite a user.

Creates a pending invitation to the organization (orgId) for the email in the request, at the requested role. The invitee sees it under their own me/invitations and joins once they accept.

Requires the owner or admin role in the organization.

post/api/v1/orgs/{orgId}/invitations

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdstring required

Request body

emailstring required

Email address to invite.

rolestring required

Organization role to grant when the invitation is accepted.

Response

Created

idstring required

Invitation membership row identifier.

organizationIdstring required

Organization that sent the invitation.

organizationNamestring nullable required

Display name of the inviting organization.

invitedEmailstring nullable required

Email address that was invited.

rolestring required

Role granted when accepted.

createdAtUtcstring date-time required

UTC timestamp when the invitation was created.

expiresAtUtcstring date-time required

UTC timestamp when the invitation expires.

Changes

No recorded changes to this operation across all 32 revisions of this API.