> ## 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 coluna

> Cria uma coluna personalizada ou atualiza a que já tem a mesma chave

## Como funciona

A rota decide pela `key` dentro da entidade. Se não existe coluna ativa com essa chave, ela é criada e a resposta é `201` com `created: true`. Se já existe com o mesmo tipo, o rótulo e as opções são atualizados (e o `agent_writable`, quando você envia) e a resposta é `200` com `created: false`. Por isso você pode chamar a rota sempre que a sua integração sobe, sem conferir antes.

Sem `key`, a chave sai do rótulo: "Convênio médico" vira `convenio_medico`.

| Tipo (`type`) | Para que serve |
| - | - |
| `text` | Texto livre de até 500 caracteres |
| `number` | Número |
| `date` | Data (`AAAA-MM-DD`) |
| `select` | Uma opção de uma lista. Exige `options`, com 1 a 50 opções de até 60 caracteres |
| `boolean` | Sim ou não |

`agent_writable` diz se os agentes podem preencher a coluna durante a ligação ou a conversa. Vale `true` na criação quando você não envia.

> [!WARNING]
>
> A chave, o tipo e a entidade não mudam depois que a coluna existe. Enviar a mesma chave com outro tipo responde `409`.

## Exemplo

```bash Requisição theme={null}
curl -X POST https://api.useintegra.com.br/api/v1/crm/fields \
  -H "Authorization: Bearer ik_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "entity": "contact",
    "label": "Convênio",
    "type": "select",
    "options": ["Particular", "Unimed", "Amil"]
  }'
```

```json Resposta 201 theme={null}
{
  "created": true,
  "field": {
    "id": "ea36701c-81d9-4f33-a46f-3bf58274d29a",
    "entity": "contact",
    "key": "convenio",
    "label": "Convênio",
    "type": "select",
    "options": ["Particular", "Unimed", "Amil"],
    "position": 0,
    "agent_writable": true,
    "created_at": "2026-11-17T14:00:00.000Z",
    "updated_at": "2026-11-17T14:00:00.000Z"
  }
}
```

## Limites

| O quê | Teto |
| - | - |
| Colunas ativas por entidade | 50 |
| `label` | 60 caracteres |
| `key` | 40 caracteres: letras minúsculas, números e `_`, começando por letra |
| `options` | 50 opções de até 60 caracteres, sem repetir |

## Erros

| Status | Quando acontece | O que fazer |
| - | - | - |
| `400` | Campo inválido, `select` sem `options`, ou `options` em outro tipo | Corrija o corpo. A mensagem aponta o campo |
| `403` | A chave não tem o escopo `crm:write` | Use uma chave com o escopo certo |
| `409` | A chave já existe com outro tipo, é de uma coluna arquivada, a entidade já tem 50 colunas ativas, ou o CRM está desligado | Use outra chave, arquive uma coluna que não usa, ou ligue o CRM no painel |


## OpenAPI

````yaml POST /api/v1/crm/fields
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/fields:
    post:
      tags:
        - CRM
      summary: Criar ou atualizar um campo personalizado pela chave
      description: >-
        Upsert pela chave dentro da entidade: sem campo ativo com a chave, cria
        (201); com a chave e o MESMO tipo, atualiza o rótulo, as opções e
        agent_writable (200); com a chave e OUTRO tipo, 409 (o tipo nunca muda).
        Chave de campo arquivado também é 409: a chave não se reaproveita. Até
        50 campos ativos por entidade (409). Sem key, ela sai do rótulo. Depois
        de criado, o campo vale em custom_fields de POST e PATCH em /contacts e
        /deals.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmFieldUpsert'
      responses:
        '200':
          description: 'Já existia com o mesmo tipo: atualizado (created: false)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: boolean
                  field:
                    $ref: '#/components/schemas/CrmField'
                required:
                  - created
                  - field
        '201':
          description: 'Criado (created: true)'
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: boolean
                  field:
                    $ref: '#/components/schemas/CrmField'
                required:
                  - created
                  - field
        '400':
          description: >-
            Campo inválido; select sem options; options em outro tipo; chave
            fora do formato
          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
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
        '409':
          description: >-
            O CRM está desligado; a chave já é de um campo de outro tipo ou
            arquivado; ou a entidade já tem 50 campos ativos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
      security:
        - ApiKey: []
components:
  schemas:
    CrmFieldUpsert:
      type: object
      properties:
        entity:
          type: string
          enum:
            - contact
            - company
            - deal
          description: contact, company ou deal
        label:
          type: string
          minLength: 1
          maxLength: 60
          description: O nome que o painel mostra (até 60 caracteres)
          example: Convênio
        type:
          type: string
          enum:
            - text
            - number
            - date
            - select
            - boolean
          description: >-
            text, number, date, select ou boolean. O tipo nunca muda depois de
            criado
        key:
          type: string
          pattern: ^[a-z][a-z0-9_]{0,39}$
          description: >-
            A chave do campo. Sem ela, sai do rótulo (sem acento, minúscula, só
            letras, números e _)
          example: convenio
        options:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 60
          minItems: 1
          maxItems: 50
          description: >-
            As opções da seleção: de 1 a 50, cada uma com até 60 caracteres, sem
            repetir. Só em type select, e obrigatório nele
          example:
            - Unimed
            - Amil
        agent_writable:
          type: boolean
          description: >-
            O agente pode preencher. Default: true no campo novo; no que já
            existe, o valor atual fica
      required:
        - entity
        - label
        - type
      additionalProperties: false
    CrmField:
      type: object
      properties:
        id:
          type: string
        entity:
          type: string
          enum:
            - contact
            - company
            - deal
          description: contact, company ou deal
        key:
          type: string
          description: A chave que vai em custom_fields do contato e do negócio
        label:
          type: string
        type:
          type: string
          enum:
            - text
            - number
            - date
            - select
            - boolean
          description: >-
            text, number, date, select ou boolean. O tipo nunca muda depois de
            criado
        options:
          type:
            - array
            - 'null'
          items:
            type: string
          description: As opções, só em type select; null nos outros
        position:
          type: number
          description: A ordem na lista (menor primeiro)
        agent_writable:
          type: boolean
          description: O agente pode preencher o campo
        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
        - entity
        - key
        - label
        - type
        - options
        - position
        - agent_writable
        - 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.