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

# Criar ou atualizar contato

> Cria o contato ou atualiza o que já tem o mesmo telefone

## Como funciona

A rota decide pelo telefone. Se a organização já tem um contato com esse número, ele é atualizado com o que você enviou e a resposta é `200` com `created: false`. Sem ele, um contato novo é criado e a resposta é `201` com `created: true`.

* **O que você não envia fica como está.** Para tirar o nome, o e-mail ou a empresa, envie `null`.
* **`tags` substitui a lista inteira.** Para acrescentar uma tag sem perder as outras, leia o contato antes e envie a lista completa.
* **`company` é o nome da empresa.** A empresa de mesmo nome é reaproveitada, e uma nova é criada quando não existe.
* **`custom_fields` preenche as colunas personalizadas**, pela chave de cada coluna. As chaves que não vierem ficam como estão, e `null` tira o valor.

## Colunas personalizadas

Cada chave de `custom_fields` tem que ser de uma coluna ativa de contato. Crie as colunas no painel, em **CRM > Contatos > Nova coluna** ou em **CRM > Configurações**, ou pela rota [Criar ou atualizar coluna](https://docs.useintegra.com.br/api-reference/endpoint/crm-save-field.md).

| Tipo da coluna | Valor que você envia |
| - | - |
| `text` | Texto de até 500 caracteres |
| `number` | Número |
| `date` | Data no formato `AAAA-MM-DD` |
| `select` | Uma das opções da coluna |
| `boolean` | `true` ou `false` |

> [!WARNING]
>
> Uma chave que não existe, ou um valor fora do tipo da coluna, recusa a requisição inteira com `400`. A mensagem aponta a chave: `custom_fields.cargo: no active custom field with this key in this organization`. Nada é gravado.

## Exemplo

```bash Requisição theme={null}
curl -X POST https://api.useintegra.com.br/api/v1/crm/contacts \
  -H "Authorization: Bearer ik_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+5511987654321",
    "name": "Ana Souza",
    "email": "ana@clinicasol.com.br",
    "company": "Clínica Sol",
    "tags": ["lead-do-site"],
    "custom_fields": {
      "cargo": "Sócia",
      "lead_desde": "2026-11-17",
      "aceita_ligacao": true
    }
  }'
```

```json Resposta 201 theme={null}
{
  "created": true,
  "contact": {
    "id": "4ef00407-020c-4cc0-b41c-af8109e9c406",
    "name": "Ana Souza",
    "email": "ana@clinicasol.com.br",
    "phone": "+5511987654321",
    "company": { "id": "0b5c1c1e-7a57-4d0c-9a39-2f6d3b1f4c10", "name": "Clínica Sol" },
    "source": "api",
    "tags": ["lead-do-site"],
    "custom_fields": {
      "aceita_ligacao": true,
      "cargo": "Sócia",
      "lead_desde": "2026-11-17"
    },
    "legal_basis": null,
    "opt_out": false,
    "opt_out_at": null,
    "last_interaction_at": null,
    "created_at": "2026-11-17T14:00:00.000Z",
    "updated_at": "2026-11-17T14:00:00.000Z"
  }
}
```

## Erros

| Status | Quando acontece | O que fazer |
| - | - | - |
| `400` | Campo inválido, telefone fora do E.164, coluna que não existe ou valor fora do tipo | Corrija o corpo. A mensagem aponta o campo |
| `403` | A chave não tem o escopo `crm:write`, ou o plano chegou ao limite de contatos (só na criação) | Use uma chave com o escopo certo. No limite, troque de plano ou apague contatos que não usa |
| `409` | O CRM está desligado na organização | Ligue no painel, em **CRM > Configurações** |
| `503` | Não foi possível conferir o limite de contatos do plano (só na criação). Nada é criado | Repita em alguns segundos |


## OpenAPI

````yaml POST /api/v1/crm/contacts
openapi: 3.1.0
info:
  title: Integra BFI API
  version: 1.0.0
  description: >
    <img src="/public/logo_dark.webp" alt="Integra" height="36"
    style="margin-bottom:16px" />


    A API da Integra para integrações externas.


    > [!tip]

    > **Copie a documentação completa para sua IA favorita:**

    > [Abrir página de cópia](/docs/markdown) ou baixe o [llm.txt](/llm.txt)


    ---


    ## Como começar


    ### 1. Gerar sua API Key


    Acesse o painel da Integra em **Settings > API Keys** e clique em **Nova API
    Key**.


    > [!important]

    > Copie a key gerada (`ik_live_...`) imediatamente: ela **só será exibida
    uma vez**.


    ### 2. Autenticar requests


    Envie o header `Authorization` em todas as chamadas:


    ```

    Authorization: Bearer ik_live_sua_key_aqui

    ```


    ### 3. Fazer sua primeira chamada


    ```bash

    curl -H "Authorization: Bearer ik_live_xxx" \
      https://api.useintegra.com.br/api/v1/campaigns
    ```


    > [!success]

    > Se a resposta for `200 OK` com JSON, sua integração está funcionando!


    ---


    ## Rate Limiting


    | Header | Descrição |

    |--------|-----------|

    | `X-RateLimit-Limit` | Limite total (60/min) |

    | `X-RateLimit-Remaining` | Requests restantes |

    | `X-RateLimit-Reset` | Timestamp de reset (epoch) |


    > [!warning]

    > Ao exceder **60 requests/minuto** por API Key, a API retorna status `429
    Too Many Requests`.


    ---


    ## Erros comuns


    | Status | Erro | Causa |

    |--------|------|-------|

    | `401` | Invalid API key | Key inválida ou revogada |

    | `403` | Forbidden | Key sem permissão para o recurso |

    | `429` | Rate limit exceeded | Excedeu 60 req/min |

    | `500` | Internal server error | Erro interno, contate o suporte |
servers:
  - url: https://api.useintegra.com.br
    description: Production
security:
  - ApiKey: []
tags:
  - name: Campaigns
    description: Gerenciamento de campanhas de voz e WhatsApp
  - name: Calls
    description: Histórico de chamadas
  - name: CRM
    description: 'CRM Integra da organização: funis, contatos, negócios e atividades'
  - name: Automations
    description: Dispara as automações com o gatilho Chamada pela nossa API
  - name: Meetings
    description: Reuniões que os agentes marcaram na agenda da organização
  - name: Webhooks
    description: Gerenciamento de webhooks para notificações em tempo real
paths:
  /api/v1/crm/contacts:
    post:
      tags:
        - CRM
      summary: Criar ou atualizar um contato pelo telefone
      description: >-
        Upsert pelo telefone: o contato da organização com o mesmo telefone (com
        ou sem o 9º dígito) é atualizado com o que veio; sem ele, um contato
        novo é criado, se couber no limite de contatos do plano.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmContactUpsert'
      responses:
        '200':
          description: 'Já existia: atualizado (created: false)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: boolean
                  contact:
                    $ref: '#/components/schemas/CrmContact'
                required:
                  - created
                  - contact
        '201':
          description: 'Criado (created: true)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: boolean
                  contact:
                    $ref: '#/components/schemas/CrmContact'
                required:
                  - created
                  - contact
        '400':
          description: >-
            Campo inválido, telefone fora do E.164, campo personalizado que não
            existe ou valor fora do tipo, ou JSON malformado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '401':
          description: Não autenticado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '403':
          description: >-
            A chave não tem o escopo crm:write, ou o limite de contatos do plano
            foi atingido (contato novo)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: >-
            O CRM está desligado na organização (ligue no painel, em CRM >
            Configurações)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '503':
          description: >-
            O limite de contatos do plano não pôde ser verificado (contato
            novo). Nada foi criado; repita depois
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
      security:
        - ApiKey: []
components:
  schemas:
    CrmContactUpsert:
      type: object
      properties:
        phone:
          type: string
          minLength: 1
          maxLength: 40
          description: >-
            Telefone em E.164, com o + e o código do país (+5511987654321).
            Espaço, parênteses, ponto e traço são aceitos e saem. Celular
            brasileiro sem o 9º dígito ganha o 9
          example: '+5511987654321'
        name:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 160
          description: Nome; null tira
        email:
          type:
            - string
            - 'null'
          maxLength: 254
          pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
          example: ana@clinica.com.br
        company:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 160
          description: >-
            Nome da empresa: a de mesmo nome (sem diferença de maiúscula) ou uma
            nova. null tira a empresa do contato
        tags:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 40
          maxItems: 30
          description: >-
            Até 30 tags, cada uma com até 40 caracteres; a repetida sai.
            Substitui a lista inteira
          example:
            - vip
        custom_fields:
          type: object
          additionalProperties:
            anyOf:
              - type: string
                maxLength: 500
              - type: number
              - type: boolean
              - type: 'null'
              - type: 'null'
          description: >-
            Campos personalizados (os criados no painel, em CRM >
            Configurações), pela chave: texto (até 500), número, data
            (AAAA-MM-DD), uma das opções da seleção ou true/false. null tira o
            valor. As chaves que não vierem ficam como estão
          example:
            convenio: Unimed
        legal_basis:
          type:
            - string
            - 'null'
          enum:
            - consent
            - legitimate_interest
            - contract
            - legal_obligation
          description: >-
            Base legal (LGPD): consent, legitimate_interest, contract ou
            legal_obligation
        opt_out:
          type: boolean
          description: 'true: não quer ser contatado (a campanha pula); false desfaz'
      required:
        - phone
      additionalProperties: false
    CrmContact:
      type: object
      properties:
        id:
          type: string
        name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
          description: E.164 (nulo no contato só do Instagram ou do Messenger)
        company:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
        source:
          type: string
          enum:
            - manual
            - import
            - api
            - assistant
            - call
            - whatsapp
            - instagram
            - messenger
            - campaign
          description: >-
            De onde veio: manual, import, api, assistant, call, whatsapp,
            instagram, messenger ou campaign
        tags:
          type: array
          items:
            type: string
        custom_fields:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
        legal_basis:
          type:
            - string
            - 'null'
          enum:
            - consent
            - legitimate_interest
            - contract
            - legal_obligation
          description: Base legal (LGPD)
        opt_out:
          type: boolean
          description: Não quer ser contatado (a campanha pula)
        opt_out_at:
          type:
            - string
            - 'null'
          description: Desde quando
          example: '2026-11-02T14:00:00.000Z'
        last_interaction_at:
          type:
            - string
            - 'null'
          description: Última ligação ou conversa
          example: '2026-11-02T14:00:00.000Z'
        created_at:
          type: string
          description: Criação (UTC)
          example: '2026-11-02T14:00:00.000Z'
        updated_at:
          type: string
          description: Última mudança (UTC)
          example: '2026-11-02T14:00:00.000Z'
      required:
        - id
        - name
        - email
        - phone
        - company
        - source
        - tags
        - custom_fields
        - legal_basis
        - opt_out
        - opt_out_at
        - last_interaction_at
        - created_at
        - updated_at
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'API Key da organização (Authorization: Bearer ik_live_xxx)'

````

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