Teams

Invite a team member

Send an email invitation to join the team with the given role. The invitee becomes a member once they accept.

Required permission: teams_update

post/api/v2/teams/{slug}/members/

Request

  • Base URL: https://app.biel.ai
  • URL: https://app.biel.ai/api/v2/teams/{slug}/members/
  • Auth: API key in header Authorization

Path parameters

slugstring required

URL slug used to address the team.

Request body

emailstring email required

Email address to send the invitation to.

role'admin' | 'maintainer' | 'editor' | 'viewer'

Role the invitee will have once they accept.

Response

Invitation sent successfully

idstring required

Invitation id.

emailstring email required

Invited email address.

role'admin' | 'maintainer' | 'editor' | 'viewer' required

Role the invitee will have once they accept.

is_acceptedboolean required

Whether the invitation has been accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.