Invite member to organization

Send an invitation email to a user to join the organization. If the user doesn't exist, a pending user will be created.

post/v1/organizations/{organizationRef}/members/invite

Request

Base URL: https://example.com/api
URL: https://example.com/api/v1/organizations/{organizationRef}/members/invite
Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization)

emailstring email required

Email address of the user to invite.

role_idstring

Optional role ID to assign the user to when they accept the invitation.

{
  "email": "user@example.com",
  "role_id": "9bsv0s46s6s002p9ltq0"
}

Example response

idstring required

ID of the newly created resource.