Archive a user group

Starts a background job that moves everything assigned to the user group to another group, then archives the group. Pass reassign_user_group_id to move team members, API keys, webhooks, task schedules, tasks, applications and policies (in both environments) to that group. Omit it to remove everything from the group instead: applications, policies, tasks and task schedules are unassigned, webhooks scoped to the group are archived and API keys scoped to the group are revoked. A group that still has team members cannot be archived without reassign_user_group_id. Claims and complaints follow their policy. Poll GET /user-groups/USER_GROUP_ID/archive for progress. Only an organisation-level actor with a user session may archive a user group, and only from the production environment, because the job moves the group's sandbox and production items together.

Path Params
string
required

Must be a UUID. The unique identifier of the user group to archive.

Body Params
string

Must be a UUID. The active user group to move everything to.

Responses

400

The group still has team members and no reassign_user_group_id was given, the group was reassigned to itself, or the request was made against the sandbox environment.

403

The feature is not enabled for the organization, the caller is not an organisation-level actor, or the credential is not a dashboard user session.

404

The user group or the reassignment group does not exist or is archived.

409

The group, or the reassignment group, is already being archived, or the group is receiving another archive's items.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json