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

# Afiliação

> Atributos e payload do evento de afiliação (criada, solicitada, aprovada).

## Atributos

Esta é a descrição dos parâmetros enviados pelo webhook em resposta a determinado evento.

| Nome do parâmetro | Descrição | Formato e tamanho suportado |
| - | - | - |
| event | Tipo de evento. Ver os **valores possíveis** abaixo. | String até 255 caracteres |
| status | Status da afiliação. Ver os **valores possíveis** abaixo. | String até 255 caracteres |
| from\_auto\_affiliation | Indica se a afiliação foi criada automaticamente. Possíveis valores: 0 (Não foi criada automaticamente). | Número inteiro |
| creator\_name | Nome do criador da afiliação | String até 255 caracteres |
| creator\_email | Email do criador da afiliação | String no formato de email |
| code | Código da afiliação | String até 255 caracteres |
| commission\_percentage | Porcentagem de comissão | Número inteiro entre 0 e 100 |
| product\_id | Identificador do produto associado à afiliação | Número inteiro com até 20 dígitos |
| product\_name | Nome do produto associado à afiliação | String até 255 caracteres |
| affiliate\_id | Identificador do afiliado | Número inteiro com até 20 dígitos |
| name | Nome do afiliado | String até 255 caracteres |
| email | Email do afiliado | String no formato de email |
| phone | Telefone do afiliado | String contendo números e caracteres especiais |
| document | CPF do afiliado | String no formato de CPF |
| affiliation\_date | Data da afiliação | String no formato de data |

## Valores possíveis

<AccordionGroup>
  <Accordion title="event" description="Tipo de evento.">
    | Valor | Descrição |
    | - | - |
    | `AFFILIATION_CREATED` | Afiliação Criada |
    | `AFFILIATION_REQUESTED` | Afiliação Solicitada |
    | `AFFILIATION_APPROVED` | Afiliação Aprovada. |
  </Accordion>

  <Accordion title="status" description="Status da afiliação.">
    | Valor | Descrição |
    | - | - |
    | `approved` | Afiliação Aprovada |
    | `pending` | Afiliação Pendente. |
  </Accordion>
</AccordionGroup>

## Objeto de requisição

Segue um exemplo do objeto da requisição:

```json theme={null}
{
    "event": "AFFILIATION_CREATED",
    "status": "approved",
    "from_auto_affiliation": 0,
    "creator_name": "Nome do criador da afiliação",
    "creator_email": "emailcriadordafiliacao8@provedor.com.br",
    "code": "AF79BE3C59",
    "commission_percentage": 10,
    "product_id": 48052,
    "product_name": "Nome do produto",
    "affiliate_id": 1212480,
    "name": "Nome do afiliado",
    "email": "emaildoafiliado8@provedor.com.br",
    "phone": "258139121334567",
    "document": "696.891.960-57",
    "affiliation_date": "2023-12-01 00:00:00",
}
```


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