Delete a contract

DELETE

/content/management/v1/contracts/{id}

const url = 'https://api.ebitex.io/content/management/v1/contracts/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/contracts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Deletes a contract and its version history. It is refused while anything depends on it: a contract that inherits from it, a component of it, a folder or template that lists it as allowed or supported, a template using it as its settings contract, an adapter reading or producing it, a stream sourcing it, or a field that names it in allowedContractIds.

getContractUsages lists the same dependents with names, so you can remove them first.

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

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

204

204 No Content.

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

permission_denied: the key’s role lacks content.contracts.manage.

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 contract with this id exists in the key’s environment.

409

has_dependents: other data depends on this contract. blockers groups the dependents’ ids by reason: has_children, has_components (a count), referenced_by_folder_constraints, referenced_by_template_constraints, referenced_by_template_settings, referenced_by_adapter_constraints, referenced_by_streams and referenced_by_field_constraints. contract_read_only: the contract is synced from a content provider. inherited_read_only: the contract 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.