Skip to main content
POST
/
console
/
v1
/
users
/
invite
Invite user. To avoid spamming, invitation emails are not sent. Invitee will see invitation notification in-app after logging in.
curl --request POST \
  --url https://statsigapi.net/console/v1/users/invite \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "role": "<string>",
  "emails": [
    "jsmith@example.com"
  ],
  "teams": [
    "<string>"
  ]
}
'
{
  "message": "User(s) Invited successfully"
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Body

application/json
​
role
string
required

Role assigned to the invited users. Can be 'Admin', 'Read Only', 'Member', or any custom role name.

​
emails
string<email>[]
required

List of email addresses to send invitations to. Invitee Emails must have the same domain to your company email domain.

​
teams
string[]

Optional list of teams that the invited users will be associated with.

Response

Invite user response

​
message
string