Skip to content

Update a blog category

PUT
/stores/{storeRef}/blog/categories/{id}
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

id
required
integer

The blog category ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
name

Display name.

string
slug

URL slug, unique within the store.

string
description

Description of the category.

string
color

Hex colour such as #ff6600.

string
sort_order

Manual position in the category list; lower comes first.

number

Example generated

{
"name": "example",
"slug": "example",
"description": "example",
"color": "example",
"sort_order": 1
}
Media typeapplication/json
object
description

Description, or null.

string
nullable
color

Hex colour such as #ff6600, or null.

string
nullable
sort_order

Manual position in the category list; lower comes first.

number
nullable
id
required

Category ID.

number
name
required

Display name.

string
slug
required

URL slug, unique within the store.

string
post_count

Number of posts in the category. Present when post counts are included; always present on the paginated list.

number
created_at

When the category was created, as an ISO 8601 timestamp.

string
nullable
updated_at

When the category was last updated, as an ISO 8601 timestamp.

string
nullable

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}