YAyampi
Catálogo - Marcas

Atualizar marca

Atualiza os detalhes de uma marca específica

put/{alias}/catalog/brands/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/catalog/brands/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da marca

Request body

namestring required

Nome da marca. Esse valor deve ser único. O valor é sanitizado e normalizado automaticamente.

activeboolean required

Se a marca está ativo

featuredboolean required

Indica se a marca é destacada na navegação da loja

descriptionstring

Descrição da marca. O valor é sanitizado e normalizado automaticamente.

logo_urlstring uri

URL do logo da marca

Example request

{
  "name": "Yampi",
  "description": "Marca X de produtos",
  "logo_url": "https://foo.bar/logo.png"
}

Response

Marca atualizada com sucesso

Example response

{
  "data": {
    "name": "Nome da marca",
    "description": "Descrição da marca",
    "logo_url": "https://foo.bar/logo.png"
  }
}

Changes

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