Sign in
organizations

Invite a user to the organization by email.

Changed on

The invite token and redeem link are returned in plaintext exactly once on this response and cannot be retrieved again.

post/organizations/{id}/invites

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/organizations/{id}/invites
  • Auth: none declared

Path parameters

idstring required

Request body

emailstring email required
roleIdstring

Response

Response

redeemUrlstring uri required
emailSentboolean required
reissuedboolean required

Changes

  • 5ab9b204a215Revision changes
    • warning

      changed the pattern of the request property from ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

    • info

      the / response's property pattern was changed from ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ for the status

  • 65dbe8a0485cRevision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status