Delete a label (DELETE /api/public/labels/{labelId})

Delete a label. Trainees that have this label will keep the others.

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Path parameters

Path parameters
Name	Type	Description
`labelId`required	`string`

Header parameters

Header parameters
Name	Type	Description
`Idempotency-Key`	`string`	Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request examples

cURL

curl --request DELETE \
  --url 'https://api.coach-platform.com/api/public/labels/<labelId>' \
  --header 'Authorization: Bearer cp_live_...'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/labels/<labelId>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();

Responses

`200` OK

The OpenAPI spec does not describe a response body here.

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.