Ecommerce

Create/Update a category

post/categories

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/categories
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

idstring email required

Unique Category ID as saved in the shop

namestring

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

urlstring

URL to the category

updateEnabledboolean

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

deletedAtstring

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

isDeletedboolean

category deleted from the shop's database

Example request

{
  "id": "CAT123",
  "name": "Electronics",
  "url": "http://mydomain.com/category/electronics",
  "deletedAt": "2017-05-12T12:30:00.000+0000",
  "isDeleted": true
}

Response

Category created

idinteger

ID of the category when a new category is created

Example response

{
  "id": 122
}

Changes

No recorded changes to this operation across all 2 revisions of this API.