Invites
Invites let new people join your account. An invite is open until the person accepts it or it expires 30 days after creation.
Keys with the Read Only role can list invites. Keys with the Admin role can list, create, and cancel invites. Invite lists are small and not paginated.
List Invites
Section titled “List Invites”GET /account/{accountId}/invite
| Required role |
|---|
| Admin or Read Only |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | number | Yes | Your account ID. |
Response
Status 200.
| Name | Type | Description |
|---|---|---|
items | array | Open invites, described below. |
| Name | Type | Description |
|---|---|---|
accountId | number | The account ID. |
accountName | string | The account name. |
email | string | The invited email address. |
roles | array of strings | The roles the person receives. |
ttl | number | When the invite expires, in epoch seconds. |
Create Invite
Section titled “Create Invite”POST /account/{accountId}/invite
| Required role |
|---|
| Admin |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | number | Yes | Your account ID. |
Request body
Send Content-Type: application/json. Fields other than those listed are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
email | string | Yes | A valid email address, 3 to 254 characters. It is lowercased. |
roles | array of strings | Yes | 1 to 4 unique roles from account-admin, account-owner, team-admin, and standard-user. |
sendEmail | boolean | Yes | Set to true to email the invitation. |
Response
Status 200. Returns the invite.
| Name | Type | Description |
|---|---|---|
accountId | number | The account ID. |
email | string | The invited email address. |
accountName | string | The account name. |
roles | array of strings | The roles the person receives. |
ttl | number | When the invite expires, in epoch seconds. |
Errors
| Status | When |
|---|---|
404 | The account does not exist. |
409 | The account has reached its limit of open invites. |
409 | An invite for that email already exists. |
409 | Users plus open invites have reached the account’s user limit. |
Notes
- An
invite-createentry is written to the audit log with your API key as the actor.
Delete Invite
Section titled “Delete Invite”DELETE /account/{accountId}/invite/{email}
| Required role |
|---|
| Admin |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | number | Yes | Your account ID. |
email | string | Yes | The invited email address, URL-encoded. |
Response
Status 200 with an empty object.