Skip to main content
POST
Create a permission group
Creates a permission group. A new group holds no grants — make them with the Permissions API once the group exists.

Request body

users takes user ids, which are integers, not the UUIDs used to identify groups and resources. Get them from List Recipients.

Response

201, with the permission group object.

Create a team and grant it access

The two calls that set a team up. After this, onboarding anybody onto that team is one membership call.

Errors

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Body

name
string
required
Maximum string length: 150
users
integer[]
required

Users (Expandable)

description
string | null

Response

201 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 150
all_group
boolean
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
users
integer[]
required

Users (Expandable)

description
string | null