Delete a component

DELETE

/content/management/v1/components/{id}

const url = 'https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Deletes a component and answers 204 No Content. The delete is refused while anything still depends on it: another component or a page referencing it, an Adapter looking it up by its rules, a live published copy in any delivery environment, or a translation job still in progress. Remove the references, unpublish it, or let the job finish, then try again. GET …/usages/closure lists everything that holds it.

The key needs delete on the component’s folder under the branch access rules. Components inherited from another environment cannot be deleted here.

Key: a management key with content.management.authoring.

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

204

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

402

payment_required: the organization’s subscription needs attention.

403

access_denied: the key’s role may view the component but not delete it.

scope_denied: the key lacks this route’s scope. tier_required: the Content Management API needs the Pro plan or above. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Content is not enabled for the organization.

404

No component has this id in the key’s environment, or it is in a branch the key’s role cannot view.

409

referenced_by: still referenced; usages lists the components and pages that reference it and adapters the Adapters that look it up. component_published: still published in the deliveryEnvironments listed; unpublish it first. component_has_translation_jobs: a translation job for it is still in progress. inherited_read_only: the component is inherited from another environment.

429

Rate limit or quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.