YAyampi
Marketing

Criar banner

Cria um novo banner

post/{alias}/marketing/banners

Request

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

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean

Indica se o banner está ativo

homeboolean

Indica se o banner aparece na home

namestring

Nome do banner. O valor é sanitizado e normalizado automaticamente.

linkstring

Link do banner

image_urlstring

URL da imagem do banner

start_atstring date-time

Data e hora de início

end_atstring date-time

Data e hora de término

categories_idsinteger[]

IDs das categorias

collections_idsinteger[]

IDs das coleções

promotions_idsinteger[]

IDs das promoções

Example request

{
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00"
}

Response

Banner criado com sucesso

idinteger

ID do banner.

product_idinteger

ID do produto vinculado ao banner, exigido quando type for product.

activeboolean

Indica se o banner está ativo.

typestring

Tipo do banner: image (banner de imagem) ou product (banner vinculado a um produto).

namestring

Nome de identificação do banner.

slugstring

Slug do banner, gerado a partir do nome.

linkstring

URL de destino ao clicar no banner.

expiredboolean

Indica se a data de término de exibição do banner já passou.

image_urlstring

URL da imagem do banner exibida em desktop.

mobile_image_urlstring

URL da imagem do banner exibida em dispositivos móveis.

homeboolean

Indica se o banner é exibido na página inicial da loja.

stopwatchstring

Tipo da contagem regressiva exibida no banner: daily (reinicia todo dia) ou expiration_date (conta até a data de término).

Example response

{
  "stopwatch_expires_in": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

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