Create/Update a category | Brevo API Documentation

Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned. When `updateEnabled` is `true`, the endpoint performs an upsert, returning `201` for a new category or `204` when an existing category is updated. The `name` field is mandatory for creation but optional for updates.

Create a new ecommerce category or update an existing one, identified by the mandatory id field. When updateEnabled is set to false (the default), the endpoint performs an insert and returns 201; if the category ID already exists, a 400 error is returned. When updateEnabled is true, the endpoint performs an upsert, returning 201 for a new category or 204 when an existing category is updated. The name field is mandatory for creation but optional for updates.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Values to create/update a category

idstringRequired

Unique Category ID as saved in the shop

deletedAtstringOptional

UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop’s database

isDeletedbooleanOptional

category deleted from the shop's database

namestringOptional

Mandatory in case of creation. Name of the Category, as displayed in the shop

updateEnabledbooleanOptionalDefaults to false

Facilitate to update the existing category in the same request (updateEnabled = true)

urlstringOptional

URL to the category

Response

Category created

idstring

ID of the category when a new category is created

Errors

400

Bad Request Error

The API key should be passed in the request headers as api-key for authentication.

Values to create/update a category

Unique Category ID as saved in the shop

UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop’s database

category deleted from the shop's database

Mandatory in case of creation. Name of the Category, as displayed in the shop

Facilitate to update the existing category in the same request (updateEnabled = true)

ID of the category when a new category is created

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.ecommerce.createUpdateCategory({
8	id: "CAT123",
9	});
10	}
11	main();

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.ecommerce.createUpdateCategory({
8	id: "CAT123",
9	});
10	}
11	main();