> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecorvex.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar brinde

> Mesmos campos da criação. `minCartQuantity` / `maxCartQuantity` são do carrinho; não use esses nomes em order bumps.



## OpenAPI

````yaml /openapi.json patch /api/v1/gifts/{giftId}
openapi: 3.0.3
info:
  title: Corvex API
  version: 1.0.0
  description: >-
    API pública da Corvex para gerenciar catálogo, pedidos, checkout marketing,
    webhooks, clientes e leads. Autenticação exclusiva por API Key
    (`Authorization: Bearer cvx_live_...`).
servers:
  - url: https://apiv3.usecorvex.com.br
    description: Produção
  - url: http://localhost:3333
    description: Desenvolvimento local
security:
  - bearerAuth: []
tags:
  - name: Checkout externo
    description: >-
      Criar link de pagamento a partir de um carrinho no seu site. Autenticação
      com `x-api-key` do painel (não é a API v1 `cvx_live_...`).
  - name: Produtos
    description: >-
      Catálogo da loja. Variantes aparecem só na consulta por id, em modo
      leitura.
  - name: Coleções
    description: Categorias da loja. Use para agrupar produtos na vitrine.
  - name: Kits
    description: Pacotes de produtos vendidos juntos.
  - name: Pedidos
    description: Pedidos da loja. Criar pedido continua no checkout, não nesta API.
  - name: Rastreio
    description: Envios e códigos de rastreio.
  - name: Carrinhos abandonados
    description: Checkouts iniciados e não concluídos.
  - name: Clientes
    description: Compradores agrupados por documento.
  - name: Leads
    description: Contatos capturados na loja virtual.
  - name: Order bumps
    description: Ofertas extras no checkout.
  - name: Brindes
    description: Brindes liberados por regras de carrinho.
  - name: Upsell one-click
    description: Oferta pós-compra com um clique.
  - name: Cupons
    description: 'Cupons de desconto. Não há exclusão: altere o status.'
  - name: Faixas de desconto
    description: Desconto progressivo por valor ou quantidade.
  - name: Desconto por pagamento
    description: Percentual por PIX, cartão ou boleto. Um desconto por método.
  - name: Webhooks
    description: >-
      URLs chamadas quando eventos da loja acontecem. O secret nunca é
      devolvido.
  - name: Automações
    description: >-
      Fluxos, templates de mensagem e metatags. Automações novas nascem
      desativadas (`active: false`).
paths:
  /api/v1/gifts/{giftId}:
    patch:
      tags:
        - Brindes
      summary: Atualizar brinde
      description: >-
        Mesmos campos da criação. `minCartQuantity` / `maxCartQuantity` são do
        carrinho; não use esses nomes em order bumps.
      operationId: updateGift
      parameters:
        - $ref: '#/components/parameters/StoreId'
        - $ref: '#/components/parameters/GiftId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                productId:
                  type: string
                  format: uuid
                  description: Produto que o cliente ganha como brinde.
                name:
                  type: string
                  minLength: 3
                  maxLength: 200
                description:
                  type: string
                  nullable: true
                active:
                  type: boolean
                  default: true
                minCartQuantity:
                  type: integer
                  minimum: 0
                  nullable: true
                  description: >-
                    Quantidade mínima de itens no carrinho para liberar o
                    brinde. null = sem mínimo. Este campo não existe em order
                    bumps.
                maxCartQuantity:
                  type: integer
                  minimum: 0
                  nullable: true
                  description: >-
                    Quantidade máxima de itens no carrinho para liberar o
                    brinde. null = sem máximo. Este campo não existe em order
                    bumps.
                minCartTotal:
                  type: number
                  minimum: 0
                  nullable: true
                  description: >-
                    Valor mínimo do carrinho (R$) para liberar o brinde. null =
                    sem mínimo.
                maxCartTotal:
                  type: number
                  minimum: 0
                  nullable: true
                  description: >-
                    Valor máximo do carrinho (R$) para liberar o brinde. null =
                    sem máximo.
                priority:
                  type: integer
                  minimum: 0
                  default: 0
                startsAt:
                  type: string
                  format: date-time
                  nullable: true
                  description: Início da vigência em ISO 8601. null = começa imediatamente.
                endsAt:
                  type: string
                  format: date-time
                  nullable: true
                  description: Fim da vigência em ISO 8601. null = sem data de término.
                triggerProductIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    Produtos no carrinho que liberam o brinde. Array vazio =
                    qualquer produto.
            example:
              productId: 22222222-2222-4222-8222-222222222222
              name: Squeeze acima de R$ 150
              description: null
              active: true
              minCartQuantity: null
              maxCartQuantity: null
              minCartTotal: 150
              maxCartTotal: null
              priority: 0
              startsAt: null
              endsAt: null
              triggerProductIds: []
      responses:
        '200':
          description: Sucesso.
          content:
            application/json:
              example:
                success: true
                data:
                  gift:
                    id: 77777777-7777-4777-8777-777777777777
                    storeId: 11111111-1111-4111-8111-111111111111
                    productId: 22222222-2222-4222-8222-222222222222
                    productName: Squeeze
                    name: Squeeze acima de R$ 150
                    description: null
                    active: false
                    minCartQuantity: null
                    maxCartQuantity: null
                    minCartTotal: 150
                    maxCartTotal: null
                    priority: 0
                    startsAt: null
                    endsAt: null
                    triggerProductIds: []
                    createdAt: '2026-09-24T14:00:00.000Z'
                    updatedAt: '2026-09-24T14:00:00.000Z'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFoundGift'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    StoreId:
      name: X-Store-Id
      in: header
      required: true
      schema:
        type: string
        format: uuid
      description: UUID da loja. A chave precisa ter esta loja autorizada.
      example: 11111111-1111-4111-8111-111111111111
    GiftId:
      name: giftId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: UUID do brinde.
  responses:
    ValidationError:
      description: Header `X-Store-Id`, query ou body inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: X-Store-Id deve ser um UUID válido
              code: VALIDATION_ERROR
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 400
    Unauthorized:
      description: API Key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: >-
                Esta rota exige uma API Key. Use Authorization: Bearer
                cvx_live_...
              code: AUTH_API_KEY_REQUIRED
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 401
    Forbidden:
      description: >-
        Falta o escopo desta operação (`AUTH_SCOPE_DENIED`) ou a loja não está
        autorizada na chave (`AUTH_STORE_ACCESS_DENIED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: Sua API Key não tem o escopo necessário para esta operação.
              code: AUTH_SCOPE_DENIED
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 403
    NotFoundGift:
      description: Brinde inexistente nesta loja.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: Recurso não encontrado
              code: RESOURCE_NOT_FOUND
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 404
    RateLimited:
      description: Muitas requisições. Respeite Retry-After.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Segundos até poder tentar de novo.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              error:
                type: string
                example: RATE_LIMITED
              retryAfter:
                type: integer
          example:
            success: false
            message: Muitas requisições. Tente novamente em instantes.
            error: RATE_LIMITED
            retryAfter: 12
  schemas:
    ErrorBody:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details: {}
        meta:
          type: object
          properties:
            timestamp:
              type: string
              format: date-time
            status:
              type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no formato `cvx_live_...`, criada no painel Corvex. Não use JWT
        de sessão nem `x-api-key`.

````