Labels

Archive a label or group

Requires the Labels: Delete permission (on by default for admins). Archived labels drop out of the default list and cannot be applied, but passages already labelled keep them. Archiving a group also archives every label in it. Safe to repeat: archiving something already archived returns archivedCount: 0. Nothing is deleted; restore it at any time.

post/labels/{labelId}/archive

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/labels/{labelId}/archive
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

labelIdstring required

Id of the label or group. Trimmed, then 1 to 64 characters from A-Z, a-z, 0-9, _ and - (pattern ^[A-Za-z0-9_-]{1,64}$). Anything else returns 400.

Response

Success

status'success'

success on every 2xx response.

Changes

No recorded changes to this operation across all 2 revisions of this API.