> ## 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 cupom > Edita valor, teto de usos, validade e alcance de um cupom já publicado, sem precisar anunciar um código novo. Os campos omitidos ficam como estão; enviar `productIds` ou `offerIds` substitui a lista inteira de vínculos. Renomear o `code` para um que já existe na empresa responde 409. ## OpenAPI ````yaml /openapi.yaml patch /v1/coupons/{couponId} 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/coupons/{couponId}: patch: tags: - Catálogo summary: Atualizar um cupom description: >- Edita valor, teto de usos, validade e alcance de um cupom já publicado, sem precisar anunciar um código novo. Os campos omitidos ficam como estão; enviar `productIds` ou `offerIds` substitui a lista inteira de vínculos. Renomear o `code` para um que já existe na empresa responde 409. operationId: updateCoupon parameters: - schema: type: integer exclusiveMinimum: true minimum: 0 in: path name: couponId required: true description: Identificador do cupom. requestBody: required: true content: application/json: schema: type: object properties: code: type: string minLength: 1 maxLength: 25 pattern: ^[A-Z0-9_-]+$ description: Código digitado no checkout; é normalizado para maiúsculas. discountType: type: string enum: - percent - fixed description: Desconto percentual (`percent`) ou fixo (`fixed`). discountPercent: type: integer minimum: 1 maximum: 95 description: Percentual de desconto, de 1 a 95. discountAmountInCents: type: integer minimum: 1 description: Desconto fixo em centavos. appliesTo: type: string enum: - all - selected - all_except description: 'Alcance: `all`, `selected` ou `all_except`.' paymentMethods: type: array items: type: string enum: - pix - credit_card description: >- Meio de pagamento que a Ephra cobra e liquida: `pix` ou `credit_card`. `boleto` não é aceito na configuração — a plataforma não emite mais cobrança em boleto, apenas mantém legíveis as vendas antigas. minItems: 1 description: Meios de pagamento em que o cupom vale. startAt: type: string format: date-time description: Momento em que o cupom passa a valer. expiresAt: type: string format: date-time description: Momento em que o cupom para de valer. maxRedemptions: type: integer minimum: 1 description: Teto de usos confirmados. autoApply: type: boolean default: false description: Aplica sozinho para quem comprou o produto gatilho. triggerProductId: type: string description: Produto cuja compra anterior dispara o cupom automático. triggerOfferId: type: integer description: Oferta cuja compra anterior dispara o cupom automático. lookbackPeriod: type: string enum: - all - d7 - d30 - d60 description: 'Janela da compra anterior: `all`, `d7`, `d30`, `d60`.' productIds: type: array items: type: string minLength: 1 description: Produtos vinculados ao cupom na criação. offerIds: type: array items: type: integer exclusiveMinimum: true minimum: 0 description: Ofertas vinculadas ao cupom na criação. additionalProperties: false example: discountPercent: 40 maxRedemptions: 1000 responses: '200': description: Cupom 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: integer description: Identificador do cupom. code: type: string description: >- Código que o comprador digita no checkout, sempre em maiúsculas. discountType: type: string enum: - percent - fixed description: Desconto percentual (`percent`) ou fixo (`fixed`). discountPercent: type: integer nullable: true description: Percentual de desconto, de 1 a 95. discountAmountInCents: type: integer nullable: true description: Desconto fixo em centavos (R$ 20,00 = 2000). appliesTo: type: string enum: - all - selected - all_except description: >- Alcance: `all` (tudo), `selected` (só os vinculados) ou `all_except` (tudo menos os vinculados). paymentMethods: type: array items: type: string enum: - pix - credit_card - boleto - multiple_cards description: Meios de pagamento em que o cupom vale. startAt: type: string format: date-time nullable: true description: Momento em que o cupom passa a valer. expiresAt: type: string format: date-time nullable: true description: Momento em que o cupom para de valer. active: type: boolean description: Cupom aceito no checkout agora. maxRedemptions: type: integer nullable: true description: Teto de usos confirmados; `null` é ilimitado. autoApply: type: boolean description: Aplica sozinho para quem já comprou o produto gatilho. triggerProductId: type: string nullable: true description: >- Produto cuja compra anterior dispara o cupom automático. triggerOfferId: type: integer nullable: true description: >- Oferta cuja compra anterior dispara o cupom automático. lookbackPeriod: type: string enum: - all - d7 - d30 - d60 nullable: true description: >- Janela de compra anterior considerada no automático: `all`, `d7`, `d30` ou `d60`. createdAt: type: string format: date-time description: Momento de criação do cupom. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - code - discountType - discountPercent - discountAmountInCents - appliesTo - paymentMethods - startAt - expiresAt - active - maxRedemptions - autoApply - triggerProductId - triggerOfferId - lookbackPeriod - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Cupom atualizado. example: success: true data: id: 3120 code: BLACK50 discountType: percent discountPercent: 40 discountAmountInCents: null appliesTo: selected paymentMethods: - pix - credit_card startAt: '2026-11-20T03:00:00.000Z' expiresAt: '2026-12-01T02:59:59.000Z' active: true maxRedemptions: 1000 autoApply: false triggerProductId: null triggerOfferId: null lookbackPeriod: null createdAt: '2026-09-05T14:00:00.000Z' updatedAt: '2026-09-11T11:30: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 '409': description: A empresa já tem outro cupom com este código. 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 empresa já tem outro cupom com este código. example: success: false message: >- Já existe um cupom com o código BLACK50 nesta empresa. Escolha outro código. '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 ````