Rename a category group

PUT

/content/management/v1/taxonomy/groups/{id}

const url = 'https://api.ebitex.io/content/management/v1/taxonomy/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","rowVersion":1}'
};

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/taxonomy/groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "rowVersion": 1 }'

Changes the group’s display name, the only property this route changes — in the organization’s vocabulary, so in every environment and app at once. The external id, and so every category path, stays the same.

Send the rowVersion you last read to be told when someone else has renamed the group since. Omit it and the last write wins.

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

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

object

name

required

string

rowVersion

null | integer | string format: uint32

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "name": "example",
  "rowVersion": 1
}

Responses

200

The updated group, shaped as in the list.

400

validation_failed: name is missing or blank.

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 platform.taxonomy.manage, which changing the organization’s category groups and categories needs.

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 group has this id in the key’s environment.

409

concurrency_conflict: the rowVersion sent is not the group’s current one, so someone else has changed it; currentRowVersion is what it is now. taxonomy_read_only: the group or category comes from a content provider and changes only when that provider is refreshed. inherited_read_only: the item is owned by a realm above the key’s own and can only be changed there; ownerRealmId 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.