Ver .md

custom_objects.fields_bulk_update

Alterar vários campos de um objeto. Aplica o mesmo patch a vários campos (ids, até 200, do mesmo objeto): groupName (nulo tira do grupo), filterable, pinned, required e isActive. O campo-título não pode ser desativado. Devolve updated.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.fields_bulk_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_fields_bulk_update
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.fields_bulk_update)

Entrada

CampoTipoObrigatórioNota
idsstring (uuid)[]sim
patchobjectsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ids": {
      "minItems": 1,
      "maxItems": 200,
      "type": "array",
      "items": {
        "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)$"
      }
    },
    "patch": {
      "type": "object",
      "properties": {
        "groupName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 60
            },
            {
              "type": "null"
            }
          ]
        },
        "filterable": {
          "type": "boolean"
        },
        "pinned": {
          "type": "boolean"
        },
        "required": {
          "type": "boolean"
        },
        "isActive": {
          "type": "boolean"
        }
      }
    }
  },
  "required": [
    "ids",
    "patch"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.fields_bulk_update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["00000000-0000-0000-0000-000000000000"],"patch":{"pinned":true}}'

CLI:

node cli/atomiks.mjs custom_objects.fields_bulk_update --json '{"ids":["00000000-0000-0000-0000-000000000000"],"patch":{"pinned":true}}'

MCP: ferramenta custom_objects_fields_bulk_update com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "updated": {
      "type": "number"
    }
  },
  "required": [
    "updated"
  ],
  "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).