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

# Garante o link padrão de um afiliado

> Retorna o link padrão existente ou cria um novo de forma idempotente. Útil para reparar uma criação de afiliado que foi concluída sem o link automático.



## OpenAPI

````yaml /openapi.json post /affiliates/{affiliateId}/default-link
openapi: 3.1.0
info:
  title: Repass API
  description: >-
    API pública do Repass — plataforma de gestão de afiliados: programas, links,
    tracking, atribuição, conversões, comissões, payouts, fiscal (BR),
    reprocessamento, event store e webhooks.
  version: 0.1.0
servers:
  - url: https://api.userepass.com
    description: Produção
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Profile
    description: Perfil do usuário autenticado.
  - name: Guide
    description: >-
      Guia de onboarding do painel: estado de tours, telas visitadas e
      preferências por usuário e organização.
  - name: Portal
    description: >-
      Portal do afiliado: sessão por identidade de afiliado (sem org), convites
      e claim.
  - name: Programs
    description: 'Programas de afiliados: configuração, atribuição, hold e tiers.'
  - name: Commission Rules
    description: Regras de comissão versionadas (imutáveis) por programa.
  - name: Affiliates
    description: 'Ciclo de vida do afiliado: cadastro, aprovação, tier, saldo.'
  - name: Terms
    description: Termos do programa, versionados.
  - name: Materials
    description: >-
      Materiais (criativos) do programa: upload pelo gestor e download pelos
      afiliados.
  - name: Links
    description: Links rastreáveis e domínios de redirecionamento.
  - name: Coupons
    description: Cupons de afiliado e sync com gateway.
  - name: Pagamentos por PIX
    description: Habilitação de pagamentos por PIX (onboarding e documentos).
  - name: Tracking
    description: Endpoints públicos de redirect e registro de cliques.
  - name: Clicks
    description: Consulta de cliques e estatísticas de link.
  - name: Conversions
    description: 'Conversões: ingestão S2S, atribuição, matching, fraude e auditoria.'
  - name: Commissions
    description: Comissões calculadas, holds, aprovação, void e clawback.
  - name: Payouts
    description: Ciclos de pagamento, prévia, execução e comprovantes.
  - name: Invoices
    description: Notas fiscais (PJ), envio e validação (BR).
  - name: Fraud
    description: Fila de revisão e decisões de fraude.
  - name: Reprocess
    description: Reprocessamento com dry-run obrigatório e relatório de impacto.
  - name: Events
    description: Histórico de eventos para auditoria e consulta.
  - name: Notifications
    description: >-
      Notificações ao operador (falhas de sincronização, payouts e afins) —
      registro in-app espelhado por e-mail aos owners/admins.
  - name: Webhooks
    description: Endpoints de webhook, entregas, retries e dead-letter.
  - name: Ingest
    description: Ingestão de eventos de cobrança (S2S e gateways).
  - name: Settings
    description: Configurações por organização (políticas e integrações).
  - name: Billing
    description: 'Plano e cobrança: contadores de uso da organização para o painel.'
  - name: Dashboard
    description: >-
      Métricas agregadas da operação (receita, top afiliados, conversões,
      comissões, novos afiliados) para a home e os relatórios do gestor.
  - name: Health
    description: Liveness do serviço.
paths:
  /affiliates/{affiliateId}/default-link:
    post:
      tags:
        - Links
      summary: Garante o link padrão de um afiliado
      description: >-
        Retorna o link padrão existente ou cria um novo de forma idempotente.
        Útil para reparar uma criação de afiliado que foi concluída sem o link
        automático.
      operationId: ensureDefaultAffiliateLink
      parameters:
        - schema:
            type: string
            pattern: ^aff_[0-9A-HJKMNP-TV-Z]{26}$
            example: aff_01J9Z3K7Qn8vYwT2bX4cE6dF8g
          in: path
          name: affiliateId
          required: true
          description: Identificador do afiliado (prefixo `aff_`).
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Identificador único do link (prefixo `link_`).
                    example: link_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                  organizationId:
                    type: string
                    description: Identificador da organização dona do link.
                    example: org_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                  programId:
                    type: string
                    description: Identificador do programa ao qual o link pertence.
                    example: prog_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                  affiliateId:
                    type: string
                    description: Identificador do afiliado dono do link.
                    example: aff_01J9Z3K7Qn8vYwT2bX4cE6dF8g
                  token:
                    type: string
                    description: Token público do link (em minúsculas), único globalmente.
                    example: maria-silva
                  subId:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      Identificador de subcampanha/origem, ou `null` se não
                      definido.
                    example: instagram-bio
                  destinationUrl:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: >-
                      URL de destino do redirecionamento, ou `null` quando usa o
                      destino padrão do programa.
                    example: https://loja.exemplo.com/produto
                  isDefault:
                    type: boolean
                    description: >-
                      Indica se este é o link padrão do afiliado (gerado
                      automaticamente).
                  status:
                    type: string
                    enum:
                      - active
                      - inactive
                    description: >-
                      Situação do link. `active`: aceita cliques e redireciona.
                      `inactive`: desativado, não redireciona (token segue
                      reservado por 12 meses).
                    example: active
                  deactivatedAt:
                    anyOf:
                      - type: string
                        format: date-time
                      - type: 'null'
                    description: >-
                      Data/hora (ISO-8601) em que o link foi desativado, ou
                      `null` se ativo.
                    example: '2026-06-13T12:00:00.000Z'
                  createdAt:
                    description: Data/hora (ISO-8601) de criação do link.
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                  updatedAt:
                    description: Data/hora (ISO-8601) da última atualização do link.
                    example: '2026-06-13T12:00:00.000Z'
                    type: string
                    format: date-time
                  url:
                    description: >-
                      URL pública e clicável do link (`{domínio}/t/{token}`), já
                      no domínio próprio/primário da organização quando
                      configurado. `null`/ausente quando a API não tem um
                      domínio base — o cliente usa o fallback local.
                    example: https://go.userepass.com/t/maria-silva
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - id
                  - organizationId
                  - programId
                  - affiliateId
                  - token
                  - subId
                  - destinationUrl
                  - isDefault
                  - status
                  - deactivatedAt
                  - createdAt
                  - updatedAt
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API (prefixo `rstr_`) enviada como `Authorization: Bearer
        rstr_...`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API (prefixo `rstr_`) enviada no header `x-api-key`.

````