Labels

Merge a label into another

Requires both Labels: Update and Labels: Delete. Moves every use of the label in the path onto targetLabelId, then archives it with mergedInto set. A passage that already had both labels keeps one. A merged label cannot be restored.

movedCount is the number of labelled passages changed across the whole company.

Errors

  • 400 when the two ids are the same, when either is a group, or when either is archived.
  • 403 without both permissions.
  • 404 when either label does not exist.
post/labels/{labelId}/merge

Request

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

Path parameters

labelIdstring required

Id of the label to merge away. 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.

Request body

targetLabelIdstring required

Id of the label to keep. 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.