Developers
Taxonomies

Update a taxonomy

PATCH/products/{product_id}/taxonomies/{taxonomy_id}

Updates the name and plural_name of a taxonomy.

Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting a newer version.

Taxonomies of replicated products are read-only. Attempts to update them return 403 Forbidden with the replica_readonly error code.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
taxonomy_id*string

Header Parameters

If-Match?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/string/taxonomies/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "name": "string",    "object": "taxonomy",    "plural_name": "string",    "product_id": "string",    "revision": "string",    "terms_count": 0,    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a taxonomy GET

Retrieves a taxonomy of a product by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating or deleting the taxonomy to avoid overwriting a newer version.

Delete a taxonomy DELETE

Moves the taxonomy and all of its terms to the trash. The terms are also removed from every lesson they were assigned to. Send the `ETag` returned by the retrieve operation in the `If-Match` header to avoid deleting a taxonomy that has changed since it was retrieved. Taxonomies of replicated products are read-only and cannot be deleted. Attempts to delete them return `403 Forbidden` with the `replica_readonly` error code.