POST /categories
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.
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 |
|---|---|---|---|
id |
String | Yes |
Unique Category ID as saved in the shop |
name |
String | No |
Mandatory in case of creation. Name of the Category, as displayed in the shop |
url |
String | No |
URL to the category |
updateEnabled |
Boolean | No |
Facilitate to update the existing category in the same request (updateEnabled = true) Default value: false |
deletedAt |
String | No |
UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database |
isDeleted |
Boolean | No |
category deleted from the shop's database |
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.