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

# Atualizar um order bump

> Edita os textos, as cores, a ordem de exibição e a visibilidade de um order bump já criado, sem recriar o checkout. Os campos omitidos ficam como estão. Para trocar a oferta vendida, crie outro bump e exclua este.



## OpenAPI

````yaml /openapi.yaml put /v1/order-bumps/{orderBumpId}
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/order-bumps/{orderBumpId}:
    put:
      tags:
        - Catálogo
      summary: Atualizar um order bump
      description: >-
        Edita os textos, as cores, a ordem de exibição e a visibilidade de um
        order bump já criado, sem recriar o checkout. Os campos omitidos ficam
        como estão. Para trocar a oferta vendida, crie outro bump e exclua este.
      operationId: updateOrderBump
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: orderBumpId
          required: true
          description: Identificador do order bump.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: Título exibido na caixa do order bump.
                callToAction:
                  type: string
                  minLength: 1
                  maxLength: 50
                  description: Frase do botão ou da caixa de seleção.
                description:
                  type: string
                  maxLength: 500
                  description: Texto de apoio exibido abaixo do título.
                displayImage:
                  type: string
                  format: uri
                  description: URL da imagem exibida na caixa.
                showProductImage:
                  type: boolean
                  description: Usa a imagem do produto da oferta.
                backgroundColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Cor de fundo da caixa.
                textColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Cor do texto da caixa.
                borderColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Cor da borda da caixa.
                checkboxColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Cor da caixa de seleção.
                exibitionOrder:
                  type: integer
                  exclusiveMinimum: true
                  minimum: 0
                  description: Posição da caixa entre os bumps.
                active:
                  type: boolean
                  description: Exibe a caixa no checkout.
              additionalProperties: false
            example:
              title: Leve também o Pack de Criativos 2026
              active: false
      responses:
        '200':
          description: Order bump atualizado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Identificador do order bump.
                      offerId:
                        type: integer
                        description: >-
                          Oferta adicionada à compra quando o comprador aceita o
                          bump.
                      productId:
                        type: string
                        nullable: true
                        description: >-
                          Produto em cujo checkout a caixa aparece (checkout
                          clássico).
                      checkoutId:
                        type: string
                        nullable: true
                        description: Checkout do construtor novo em que a caixa aparece.
                      title:
                        type: string
                        description: Título exibido na caixa do order bump.
                      description:
                        type: string
                        nullable: true
                        description: Texto de apoio exibido abaixo do título.
                      callToAction:
                        type: string
                        nullable: true
                        description: >-
                          Frase do botão ou da caixa de seleção, ex.: "Sim,
                          quero!".
                      displayImage:
                        type: string
                        nullable: true
                        description: URL da imagem exibida na caixa.
                      showProductImage:
                        type: boolean
                        description: >-
                          Usa a imagem do produto da oferta em vez de uma imagem
                          própria.
                      backgroundColor:
                        type: string
                        nullable: true
                        description: Cor de fundo da caixa, em hexadecimal.
                      textColor:
                        type: string
                        nullable: true
                        description: Cor do texto da caixa, em hexadecimal.
                      borderColor:
                        type: string
                        nullable: true
                        description: Cor da borda da caixa, em hexadecimal.
                      checkboxColor:
                        type: string
                        nullable: true
                        description: Cor da caixa de seleção, em hexadecimal.
                      exibitionOrder:
                        type: integer
                        description: >-
                          Posição da caixa quando o checkout mostra mais de um
                          bump.
                      active:
                        type: boolean
                        description: Bump exibido no checkout.
                      createdAt:
                        type: string
                        format: date-time
                        description: Momento de criação do order bump.
                      updatedAt:
                        type: string
                        format: date-time
                        description: Momento da última alteração.
                    required:
                      - id
                      - offerId
                      - productId
                      - checkoutId
                      - title
                      - description
                      - callToAction
                      - displayImage
                      - showProductImage
                      - backgroundColor
                      - textColor
                      - borderColor
                      - checkboxColor
                      - exibitionOrder
                      - active
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Order bump atualizado.
              example:
                success: true
                data:
                  id: clx9c1m5t0002qz0a7h8j9k0l
                  offerId: 4821
                  productId: clx8a2h4k0001qz0a1b2c3d4e
                  checkoutId: null
                  title: Leve também o Pack de Criativos 2026
                  description: 80 criativos prontos para anúncio, editáveis no Canva.
                  callToAction: Sim, quero o pack por R$ 97
                  displayImage: https://images.ephra.io/order-bumps/pack-criativos.jpg
                  showProductImage: false
                  backgroundColor: '#F4F7FB'
                  textColor: '#0B1B2B'
                  borderColor: '#1B9E4B'
                  checkboxColor: '#1B9E4B'
                  exibitionOrder: 1
                  active: false
                  createdAt: '2026-09-03T10:20:00.000Z'
                  updatedAt: '2026-09-09T17:05:00.000Z'
        '400':
          description: A requisição está bem formada, mas uma regra de negócio a recusou.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  A requisição está bem formada, mas uma regra de negócio a
                  recusou.
              example:
                success: false
                message: >-
                  Não foi possível concluir: uma regra de negócio recusou os
                  dados enviados.
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Recurso não encontrado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````