Archive a rubric

client.rubrics.archive(, ?): RubricArchiveResponse { id, deleted, object }

DELETE/v5/rubrics/{rubric_id}

Archive a rubric (soft delete).

This is a soft delete, not a permanent one: it records an archived timestamp on the rubric while retaining the rubric and its version history, so it can later be brought back via the restore variant of the update endpoint. An archived rubric is hidden from the list endpoint but stays retrievable by id. The rubric’s criteria are left untouched — archiving does not cascade to or delete them. Archiving a rubric that is already archived is rejected.

ParametersExpand Collapse

rubricID: string

ReturnsExpand Collapse

RubricArchiveResponse { id, deleted, object }

id: string

deleted: boolean

object?: "rubric"

Archive a rubric

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const response = await client.rubrics.archive('rubric_id');

console.log(response.id);

{
  "id": "id",
  "deleted": true,
  "object": "rubric"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "rubric"
}