Skip to main content
POST
Invites a member to be part of the team. The member will need to create their account if they don't exist.

Authorizations

X-API-KEY
string
header
required

Body

application/json
email
string<email>
required
Example:

"john.smith@goteal.co"

role
enum<string>
required

The Role of the Member

Available options:
FullMember
Example:

"FullMember"

Response

Created

email
string<email>
required
Example:

"john.smith@goteal.co"

role
string
required

The Role of the Member

Example:

"Owner"

status
enum<string>
required
read-only

the status of the Member

Available options:
unconfirmed,
confirmed,
archived,
compromised,
unknown,
reset_required,
force_change_password,
external_provider
Example:

"unconfirmed"

mfa_status
enum<string>
required
read-only

the status of the Member

Available options:
sms,
email,
disabled
Example:

"sms"

name
string

Names of the Member

Example:

"John Smith"