Skip to content

create_group

Create a workspace group, optionally granting its members a role.

Members added to a role-bearing group inherit that role's permissions. Requires
workspace billing-admin permission.

Parameters

ParameterTypeDefaultDescription
workspace_idrequiredstring (uuid)—The workspace to create the group in.
namerequiredstring1–∞ chars—The group's name. Must be unique within the workspace.
roleenum—Optional workspace role to grant every member (admin, editor, artist, ...). Omit for none.
One of: admin, editor, settings_admin, art_director, artist, member, installation, provisioning
role_idstring (uuid)—Id of a custom role to grant instead of a builtin `role`. Use list_roles to find one.