Create and send an organization invitation

Create an invitation to join an existing organization. The organization ID is specified in the URL.

Path parameters

organizationIdstringRequired
Organization ID to invite the user to

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
Email address of the user to invite
roleslist of stringsRequired
Array of role IDs or names to assign to the user for the organization. Must contain at least 1 role.

Response

Organization invitation created and sent successfully.
successboolean or null
messagestring or null
organizationIdstring or null

Errors