# custom_objects.field_update

Editar campo de um objeto. Muda rótulo, descrição, opções (só campos de seleção; valores já gravados que saírem das opções continuam guardados), `required`, `filterable`, `pinned`, `groupName` (nulo ou vazio tira do grupo), `unique` e `isActive`. `isActive: false` é o "Excluir campo" da tela: o campo sai dos formulários e filtros, os valores continuam guardados e voltam ao reativar (`true`). O identificador e o tipo não mudam. O campo-título não pode ser desativado: troque-o antes em `custom_objects.update`.

- Endpoint: `POST https://app.atomiks.com.br/api/v1/custom_objects.field_update` (corpo JSON)
- Quem pode chamar: administrador da conta
- Escopo da chave: `crm:write`
- Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP: `custom_objects_field_update`
- Ficha em JSON: `https://app.atomiks.com.br/api/v1/openapi.json` (operationId `custom_objects.field_update`)

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `id` | string (uuid) | sim |  |
| `displayName` | string | não |  |
| `description` | string \| null | não |  |
| `options` | string \| object[] | não |  |
| `required` | boolean | não |  |
| `filterable` | boolean | não |  |
| `pinned` | boolean | não |  |
| `isActive` | boolean | não |  |
| `groupName` | string \| null | não |  |
| `unique` | boolean | não |  |

<details><summary>JSON Schema</summary>

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "displayName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 300
        },
        {
          "type": "null"
        }
      ]
    },
    "options": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "label"
            ]
          }
        ]
      }
    },
    "required": {
      "type": "boolean"
    },
    "filterable": {
      "type": "boolean"
    },
    "pinned": {
      "type": "boolean"
    },
    "isActive": {
      "type": "boolean"
    },
    "groupName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 60
        },
        {
          "type": "null"
        }
      ]
    },
    "unique": {
      "type": "boolean"
    }
  },
  "required": [
    "id"
  ]
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.field_update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","displayName":"Bairro","required":true}'
```

CLI:

```bash
node cli/atomiks.mjs custom_objects.field_update --json '{"id":"00000000-0000-0000-0000-000000000000","displayName":"Bairro","required":true}'
```

MCP: ferramenta `custom_objects_field_update` com a mesma entrada.

## Saída

Sucesso: `{"data": ...}` com o formato abaixo.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "objectId": {
      "type": "string"
    },
    "fieldName": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "fieldType": {
      "type": "string",
      "enum": [
        "text",
        "textarea",
        "number",
        "currency",
        "percentage",
        "date",
        "select",
        "multi_select",
        "radio",
        "link",
        "rating",
        "boolean",
        "file",
        "image"
      ]
    },
    "options": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "label",
              "value"
            ],
            "additionalProperties": false
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "required": {
      "type": "boolean"
    },
    "filterable": {
      "type": "boolean"
    },
    "pinned": {
      "type": "boolean"
    },
    "isActive": {
      "type": "boolean"
    },
    "position": {
      "type": "number"
    },
    "usageCount": {
      "type": "number"
    },
    "usageByKind": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "number"
      }
    },
    "fillRate": {
      "type": "number"
    },
    "filledCount": {
      "type": "number"
    },
    "totalRecords": {
      "type": "number"
    },
    "isTitle": {
      "type": "boolean"
    },
    "groupName": {
      "type": [
        "string",
        "null"
      ]
    },
    "unique": {
      "type": "boolean"
    },
    "lastEditedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "objectId",
    "fieldName",
    "displayName",
    "fieldType",
    "options",
    "description",
    "required",
    "filterable",
    "pinned",
    "isActive",
    "position",
    "usageCount",
    "usageByKind",
    "fillRate",
    "filledCount",
    "totalRecords",
    "isTitle",
    "groupName",
    "unique",
    "lastEditedAt",
    "createdAt"
  ],
  "additionalProperties": false
}
```

## Erros

`{"error": {"code", "message", "requestId"}}`. Códigos: `invalid_input` (400), `unauthorized` (401), `forbidden` / `account_pending` / `scope_missing` (403), `not_found` (404), `limit_reached` (409), `internal` (500).