> ## 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.

# Substituir os pixels da afiliação

> Grava o conjunto completo de pixels da afiliação: o que vier na lista fica, o que ficar de fora é removido. Para incluir um pixel, mande os atuais mais o novo; para remover, mande a lista sem ele. Aceita até 20 pixels e só em afiliação aprovada. Responde 400 para afiliação não aprovada ou provedor inexistente, e 404 quando a afiliação pertence a outra empresa.



## OpenAPI

````yaml /openapi.yaml put /v1/affiliations/{affiliationId}/pixels
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`.


    **Um `429` que não é limite de requisições.** Em `POST /v1/card` e `POST
    /v1/subscriptions`, um `429` com `code: "BUYER_ATTEMPTS_EXCEEDED"` no corpo
    significa que este comprador, e só ele, está bloqueado para pagar com cartão
    depois de tentativas recusadas em excesso. Nada foi cobrado. Não pause nem
    atrase as cobranças de outros compradores por causa dele, e não repita a
    cobrança deste comprador antes de `blockedUntil` (ISO 8601 UTC, também em
    `retryAfterSeconds` e no header `retry-after`; os dois campos vêm `null`
    quando o horário não é conhecido). Pix continua disponível para o mesmo
    comprador. Diferencie os dois casos sempre pelo `code`, nunca pelo status.


    **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/affiliations/{affiliationId}/pixels:
    put:
      tags:
        - Crescimento
      summary: Substituir os pixels da afiliação
      description: >-
        Grava o conjunto completo de pixels da afiliação: o que vier na lista
        fica, o que ficar de fora é removido. Para incluir um pixel, mande os
        atuais mais o novo; para remover, mande a lista sem ele. Aceita até 20
        pixels e só em afiliação aprovada. Responde 400 para afiliação não
        aprovada ou provedor inexistente, e 404 quando a afiliação pertence a
        outra empresa.
      operationId: replaceAffiliationPixels
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: affiliationId
          required: true
          description: Identificador da afiliação.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pixels:
                  type: array
                  items:
                    type: object
                    properties:
                      pixelServiceTypeId:
                        type: integer
                        exclusiveMinimum: true
                        minimum: 0
                        description: Provedor do pixel; ver `GET /v1/pixel-providers`.
                      pixelCode:
                        type: string
                        maxLength: 200
                        description: Código do pixel na plataforma de anúncios.
                    required:
                      - pixelServiceTypeId
                      - pixelCode
                    additionalProperties: false
                  maxItems: 20
                  description: >-
                    O conjunto completo de pixels da afiliação. Lista vazia
                    remove todos.
              required:
                - pixels
              additionalProperties: false
            example:
              pixels:
                - pixelServiceTypeId: 1
                  pixelCode: '1284937561029384'
      responses:
        '200':
          description: Pixels da afiliação depois da gravação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Identificador do pixel.
                        pixelServiceTypeId:
                          type: integer
                          description: Provedor do pixel; ver `GET /v1/pixel-providers`.
                        serviceName:
                          type: string
                          nullable: true
                          description: Nome do provedor.
                        serviceSlug:
                          type: string
                          nullable: true
                          description: Identificador textual do provedor.
                        pixelCode:
                          type: string
                          description: Código do pixel na plataforma de anúncios.
                      required:
                        - id
                        - pixelServiceTypeId
                        - serviceName
                        - serviceSlug
                        - pixelCode
                      additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Pixels da afiliação depois da gravação.
              example:
                success: true
                data:
                  - id: 913
                    pixelServiceTypeId: 1
                    serviceName: Meta Ads
                    serviceSlug: meta-ads
                    pixelCode: '1284937561029384'
        '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: Só é possível cadastrar pixels em afiliações aprovadas.
        '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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.