Update a blog category
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/blog/categories/1';const options = { method: 'PUT', headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'}, body: '{"name":"example","slug":"example","description":"example","color":"example","sort_order":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://apibase.ecomweb.app/api/v1/stores/example/blog/categories/1 \ --header 'Content-Type: application/json' \ --header 'x-api-key: <x-api-key>' \ --data '{ "name": "example", "slug": "example", "description": "example", "color": "example", "sort_order": 1 }'Updates the fields you send.
Required scopes: write:blog
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The blog category ID.
The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Display name.
URL slug, unique within the store.
Description of the category.
Hex colour such as #ff6600.
Manual position in the category list; lower comes first.
Example generated
{ "name": "example", "slug": "example", "description": "example", "color": "example", "sort_order": 1}Responses
Section titled “Responses”object
Description, or null.
Hex colour such as #ff6600, or null.
Manual position in the category list; lower comes first.
Category ID.
Display name.
URL slug, unique within the store.
Number of posts in the category. Present when post counts are included; always present on the paginated list.
When the category was created, as an ISO 8601 timestamp.
When the category was last updated, as an ISO 8601 timestamp.
Example generated
{ "description": "example", "color": "example", "sort_order": 1, "id": 1, "name": "example", "slug": "example", "post_count": 1, "created_at": "example", "updated_at": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}