SMsmolmachines
org

Invite a member.

Changed on

Emails an invitation to join the organization with a given role. Requires a user login, not an API key, and the members:write scope (owner or admin).

post/v1/org/members/invite

Request

Request body

emailstring required

The address to invite, matched case-insensitively against the IdP's verified address.

rolestring required

owner, admin or member.

Response

Invitation recorded and, with a mail provider configured, sent; the body carries the accept link, the only readable copy of the token, which lapses in seven days.

emailSentboolean required

Whether the link was handed to a mailer; false on a deployment with none.

invitationUrlstring nullable

The accept link, carrying the only readable copy of the token.

Changes