Classify a component

PUT

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

const url = 'https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/categories';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"categoryIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'
};

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

curl --request PUT \
  --url https://api.ebitex.io/content/management/v1/components/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "categoryIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Replaces the component’s classification with categoryIds. The list is the whole set, so an empty list removes every category. Every id must name a selectable category in the key’s environment.

Classification is frozen into the published snapshot when the entity is next published, together with every ancestor of each category, so a delivery category= filter on a parent also matches its sub-categories. A change made here reaches delivery only after that publish. What a category is (its path and display value) is read live, so renaming or moving a category needs no republish.

Classifying needs edit access to the component’s folder, and the key’s role is held to the same folder access rules as a person with that role.

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

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

object

categoryIds

required

Array<string>

Example^generated

{
  "categoryIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

{ "categoryIds": ["…"] }, the stored set with duplicates removed.

400

validation_failed: one or more ids do not exist or are not selectable (errors.categoryIds).

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 can view the component’s folder but not edit 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, or the key’s role cannot view the folder it is in.

409

inherited_read_only: the item is inherited from another environment and can only be changed there; sourceEnvironmentId names it.

429

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