Invite a member

View as Markdown

Emails an invitation to join the caller’s organization. Body: { email: string, roleSlug?: string } — absent, the organization’s default role applies. Authorization: organization administrators only. Returns 400 on a malformed body and 422 when the address cannot be invited — e.g. it is already a member.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
roleSlugstringOptional1-64 characters

Response

The invitation that was sent.
invitationobject