Sign in
Groups

Create group

post/v1/workspaces/{workspace_id}/groups

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request body

namestring required

The group's name. Must be unique within the workspace.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'member'
role_idstring uuid nullable

Id of a custom role to grant instead of a builtin role.

Response

Successful Response

group_idstring uuid required

The group's unique identifier.

namestring required

The group's name.

role'admin' | 'editor' | 'settings_admin' | 'art_director' | 'artist' | 'member'
role_idstring uuid nullable

Id of the role actually assigned. A custom role reports its own id here while role reports the builtin floor it grants, so read this to tell the two apart.

Changes