Campos personalizados

Lista as definições de campos personalizados da conta. Use os **nomes** (`name`) retornados aqui como chaves do objeto `custom_fields` ao criar/atualizar leads.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

Listar campos personalizados

GET/custom-fields

Permissão: custom_fields:read

Parâmetros de query

active_onlybooleanopcional

Se true, retorna apenas campos ativos

Tipos de campo (field_type): text, number, currency, date, select, multiselect, checkbox.

Requisição

curl "https://app.syncro.chat/api/v1/custom-fields?active_only=true" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Resposta

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "tamanho_empresa",
      "label": "Tamanho da empresa",
      "field_type": "select",
      "options": [
        "1-10",
        "11-50",
        "51-200",
        "200+"
      ],
      "is_required": false,
      "is_active": true,
      "show_on_card": true,
      "sort_order": 1
    },
    {
      "id": 2,
      "name": "setor",
      "label": "Setor",
      "field_type": "text",
      "options": [],
      "is_required": true,
      "is_active": true,
      "show_on_card": false,
      "sort_order": 2
    }
  ]
}

Enviando valores ao criar/atualizar um lead

No POST /leads (e upsert), envie o objeto custom_fields com a chave igual ao name do campo:

{
  "name": "João Silva",
  "pipeline_id": 1,
  "stage_id": 5,
  "custom_fields": {
    "tamanho_empresa": "200+",
    "setor": "Tecnologia"
  }
}

Valores são convertidos conforme o field_type (números, datas YYYY-MM-DD, booleanos para checkbox, array para multiselect). Chaves que não existem como campo são ignoradas.

Veja Leads.