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

# Update Affiliate

> Atualiza um afiliado.



## OpenAPI

````yaml /openapi/affiliates.yaml patch /app/affiliate/{affiliate-id}
openapi: 3.1.0
info:
  title: CentralCart API
  version: 1.0.0
servers:
  - url: https://api.centralcart.io/v1
    description: Produção
security:
  - bearerAuth: []
paths:
  /app/affiliate/{affiliate-id}:
    patch:
      tags:
        - Affiliates
      summary: Update Affiliate
      description: Atualiza um afiliado.
      operationId: updateAffiliate
      parameters:
        - name: affiliate-id
          in: path
          required: true
          description: O ID do afiliado a ser atualizado
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Nome do afiliado (máximo 56 caracteres)
                ref_code:
                  type: string
                  description: >-
                    Código de referência único do afiliado (apenas letras,
                    números, hífen e underscore)
                percent_commission:
                  type: number
                  description: Percentual de comissão do afiliado (entre 1 e 100)
                email:
                  type: string
                  description: Email do afiliado
                balance:
                  type: number
                  description: Saldo do afiliado
                min_withdraw:
                  type: number
                  description: Valor mínimo para saque
                linked_discount_id:
                  type: number
                  description: ID do cupom de desconto vinculado ao afiliado
                package_commissions:
                  type: array
                  description: >-
                    Comissões personalizadas por produto. Ao enviar, todas as
                    comissões existentes serão substituídas.
                  items:
                    type: object
                    required:
                      - package_id
                      - percent_commission
                    properties:
                      package_id:
                        type: number
                        description: ID do produto
                      percent_commission:
                        type: number
                        description: Percentual de comissão para o produto (entre 0 e 100)
                withdraw_settings:
                  type: object
                  description: Configurações de saque do afiliado
                  properties:
                    full_name:
                      type: string
                      description: Nome completo do beneficiário (máximo 100 caracteres)
                    pix_key:
                      type: string
                      description: Chave PIX (máximo 100 caracteres)
                    pix_key_type:
                      type: string
                      description: >-
                        Tipo da chave PIX: `CPF`, `CNPJ`, `EMAIL`, `PHONE` ou
                        `RANDOM`
                      enum:
                        - CPF
                        - CNPJ
                        - EMAIL
                        - PHONE
                        - RANDOM
                    cpf_cnpj:
                      type: string
                      description: CPF ou CNPJ do beneficiário (máximo 18 caracteres)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                  store_id:
                    type: number
                  name:
                    type: string
                  ref_code:
                    type: string
                  percent_commission:
                    type: number
                  balance:
                    type: number
                  min_withdraw:
                    type: number
                  email:
                    type: string
                  self_affiliated:
                    type: boolean
                  linked_discount_id:
                    type: number
                    nullable: true
                  withdraw_settings:
                    type: object
                    nullable: true
                    properties:
                      full_name:
                        type: string
                      pix_key:
                        type: string
                      pix_key_type:
                        type: string
                      cpf_cnpj:
                        type: string
                  dash_secret:
                    type: string
                  package_commissions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        affiliate_id:
                          type: number
                        package_id:
                          type: number
                        percent_commission:
                          type: number
                  created_at:
                    type: string
                  updated_at:
                    type: string
              example:
                id: 1
                store_id: 1
                name: Afiliado Atualizado
                ref_code: AFFILIATE001
                percent_commission: 15
                balance: 200
                min_withdraw: 50
                email: afiliado@example.com
                self_affiliated: false
                linked_discount_id: null
                withdraw_settings:
                  full_name: João da Silva
                  pix_key: joao@email.com
                  pix_key_type: EMAIL
                  cpf_cnpj: 123.456.789-00
                dash_secret: REDACTED
                package_commissions:
                  - id: 1
                    affiliate_id: 1
                    package_id: 10
                    percent_commission: 20
                created_at: '2024-01-16T15:12:36.000-03:00'
                updated_at: '2024-01-16T16:30:45.000-03:00'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Token de API gerado no painel da CentralCart.

````

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