POST /categories/batch
Create or update multiple ecommerce categories in a single request. The categories array accepts up to 100 category objects, each requiring a unique id. When updateEnabled is false (the default), all categories are inserted as new; if any ID already exists, a 400 error is returned. When updateEnabled is true, existing categories are updated and new ones are created via upsert. Duplicate IDs within the same request payload are rejected. The response returns the count of created and updated categories.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
categories[] |
Array | Yes |
array of categories objects |
categories[].id |
String | Yes |
Unique Category ID as saved in the shop |
categories[].name |
String | No |
Mandatory in case of creation. Name of the Category, as displayed in the shop |
categories[].url |
String | No |
URL to the category |
categories[].deletedAt |
String | No |
UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database |
categories[].isDeleted |
Boolean | No |
category deleted from the shop's database |
updateEnabled |
Boolean | No |
Facilitate to update the existing categories in the same request (updateEnabled = true) |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.