Skip to main content
Invite organization members

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
emails
string<email>[]
required

The addresses to invite. An address given twice, in any case, is invited once.

Required array length: 1 - 50 elements
Maximum string length: 254
role
enum<string>
required
Available options:
admin,
member
team_ids
string<uuid>[]

Teams the person joins when they accept, before their first request. To change them, revoke the invitation and send a new one.

Maximum array length: 100
access_limit
object | null

The access limit the person gets when they accept. Omitted or null: none.

Response

The invitations sent by email and the addresses not invited. Not idempotent: after an uncertain response, list invitations and send again only the addresses still to invite.

sent
object[]
required

The invitations sent, in the order asked.

failed
object[]
required

The addresses not invited, in the order asked. invite_domain_not_allowed: the domain is not in settings.allowed_invite_domains. address_not_allowed: the Watchdog sign-in does not accept the address. already_member: they are a member. already_invited: they have a pending invitation; revoke it to send another. member_limit_reached: members and pending invitations fill the member limit. rate_limited: too many invitations were sent recently; try again later.