[BETA] Archive (soft-delete) a group by internal ID

Soft-delete a group: it is marked archived (HIDDEN) and detached from its parent. Direct child groups are orphaned (their parent is cleared) but NOT archived or deleted. Student memberships are preserved. No cascade to courses, students, trainings or alerts. Archiving a group that is already archived returns 409 Conflict with error code ARCHIVED_GROUP_EXISTS. On a successful archive the GROUP_DELETED webhook is dispatched.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The internal Edusign group ID

Responses

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