---
title: "Atualizar coleção"
method: PUT
path: "/{alias}/catalog/collections/{id}"
tags: ["Catálogo - Coleções"]
---

# Atualizar coleção

`PUT /{alias}/catalog/collections/{id}`

Atualiza os detalhes de uma coleção específica

## Path parameters

- `alias` string, required
- `id` integer, required

## Request body

- CollectionRequest — Representa os dados necessários para criar ou atualizar uma coleção de produtos
  - `active` boolean, required
  - `show_banners` boolean
  - `featured` boolean
  - `name` string, required
  - `visible_products` integer
  - `home` boolean, required
  - `slug` string
  - `description` string
  - `seo_title` string
  - `seo_description` string
  - `seo_keywords` string
  - `start_at` string, date-time, required — Data e hora de início
  - `end_at` string, date-time, required — Data e hora de término
  - `stopwatch` string
  - `url` string, uri
  - `products_ids` integer[]
  - `banners_ids` integer[]
  - `restrictions` object
    - `include` object
      - `brands_ids` integer[]
      - `categories_ids` integer[]
    - `exclude` object
      - `categories_ids` integer[]
  - `create_redirect` object — Se presente na requisição, cria um redirect junto com a atualização. A presença do nó é o que sinaliza a intenção — o conteúdo descreve o redirect.
    - `url_from` string, required — URL de origem do redirect (path relativo iniciando com /).
    - `url_to` string, required — URL de destino do redirect (path relativo iniciando com /). Deve ser diferente de url_from.

## Response `200`

Coleção atualizada com sucesso

- Collection — Representa uma coleção a qual um produto pertence
  - `id` integer
  - `parent_id` integer
  - `active` boolean
  - `show_banners` boolean
  - `featured` boolean
  - `is_promotional` boolean
  - `name` string
  - `visible_products` integer
  - `home` boolean
  - `expired` boolean
  - `slug` string
  - `description` string
  - `seo_title` string
  - `seo_keywords` string
  - `seo_description` string
  - `path` string — Caminho relativo para o recurso.
  - `expire_in` string — Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos').
  - `total_products` integer — Número total de produtos relacionados ao recurso.

## Other responses

- `400` — Requisição inválida
- `404` — Coleção não encontrada

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/versions/fa16c50bef09/schema)