Mail

Invite a user

Changed on

Requires the invitation.super permission (Admin by default). The invite always goes to the caller's organization; an organizationId in the body is ignored, and a SuperAdmin without an organization uses /super-admin/organizations/{id}/invite. Only an Admin may grant a built-in role; other inviting roles may grant only the organization's custom roles with no permission they lack.

post/mail/invite

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/mail/invite
  • Auth
    HTTP bearer

Request body

object required

Response

Invitation email sent

Changes

  • 51170dc62427Revision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

    • info

      added the success response with the status

  • d86d0bf8bebeRevision changes
    • info

      api operation id inviteLimiter removed and replaced with anonymous