API reference

Download spec
post

Invite a team member

Sends an email invite to join the team with the specified role. The invitee must accept before they appear in the members list.

Required API key scope
members:create
/api/v1/team/members/invites

Code samples

curl --request POST \
  --url https://api.emailguard.co/api/v1/team/members/invites \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Parameters

Request body

Invitee email and role to assign on acceptance

emailstringrequired

Email address that will receive the invite.

rolestringrequired

Team role to assign when the invite is accepted (for example Owner, Admin, Member). See Team roles and permissions.

Responses

200
OK
OK
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

400
Bad Request
Bad Request
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

401
Unauthorized
Unauthorized
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.

403
Forbidden
Forbidden
codestringrequired

Machine-readable status code (for example OK or INVALID_BODY).

messagestring

Human-readable detail when the code is not OK.