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

# Contatos

> Como gerenciar contatos do CRM via API

# Contatos

O recurso `contacts` permite gerenciar os contatos do CRM da sua empresa.

## Listar contatos

```bash theme={null}
curl "https://api.synax.app.br/functions/v1/api-proxy/contacts?limit=20&order=created_at.desc" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui"
```

### Filtros disponíveis

| Parâmetro         | Exemplo                 | Descrição              |
| ----------------- | ----------------------- | ---------------------- |
| `temperature=hot` | Filtrar por temperatura | `cold`, `warm`, `hot`  |
| `is_active=true`  | Filtrar ativos          | Apenas contatos ativos |
| `source=api`      | Filtrar por origem      | Origem do contato      |

### Paginação

```bash theme={null}
# Primeiros 20
?limit=20&offset=0

# Próximos 20
?limit=20&offset=20
```

## Buscar um contato

```bash theme={null}
curl "https://api.synax.app.br/functions/v1/api-proxy/contacts/{id}" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui"
```

## Criar contato

<Note>
  Requer chave com permissão de **escrita**.
</Note>

```bash theme={null}
curl -X POST "https://api.synax.app.br/functions/v1/api-proxy/contacts" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "phone": "+5511999999999",
    "email": "joao@email.com",
    "temperature": "warm",
    "tags": ["lead", "site"],
    "source": "api",
    "custom_fields": {
      "origem": "landing-page"
    }
  }'
```

### Campos obrigatórios

| Campo   | Tipo   | Descrição                                          |
| ------- | ------ | -------------------------------------------------- |
| `phone` | string | Telefone com código do país (ex: `+5511999999999`) |

### Campos opcionais

| Campo                   | Tipo      | Descrição                                |
| ----------------------- | --------- | ---------------------------------------- |
| `name`                  | string    | Nome do contato                          |
| `email`                 | string    | Email                                    |
| `temperature`           | string    | `cold`, `warm` ou `hot`                  |
| `tags`                  | string\[] | Lista de tags                            |
| `source`                | string    | Origem (ex: `api`, `manual`, `whatsapp`) |
| `job_title`             | string    | Cargo                                    |
| `empresa`               | string    | Empresa do contato                       |
| `segmento`              | string    | Segmento de mercado                      |
| `necessidade_principal` | string    | Principal necessidade                    |
| `valor_estimado`        | number    | Valor estimado do negócio                |
| `observacoes`           | string    | Observações livres                       |
| `custom_fields`         | object    | Campos personalizados (JSON livre)       |
| `do_not_contact`        | boolean   | Não contatar (opt-out)                   |

## Atualizar contato

```bash theme={null}
curl -X PATCH "https://api.synax.app.br/functions/v1/api-proxy/contacts/{id}" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui" \
  -H "Content-Type: application/json" \
  -d '{
    "temperature": "hot",
    "tags": ["lead", "site", "qualificado"]
  }'
```

## Excluir contato

```bash theme={null}
curl -X DELETE "https://api.synax.app.br/functions/v1/api-proxy/contacts/{id}" \
  -H "Authorization: Bearer sk_live_SuaChaveAqui"
```