custom_fields.groups

Grupos de campos customizados. Nomes dos grupos já usados pelos campos do escopo (para o seletor "Grupo"), em ordem alfabética.

• Endpoint: POST https://app.atomiks.com.br/api/v1/custom_fields.groups (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: custom_fields_groups
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_fields.groups)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "entityType": {
      "type": "string",
      "enum": [
        "leads",
        "opportunities"
      ]
    }
  },
  "required": [
    "entityType"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_fields.groups \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityType":"leads"}'

CLI:

node cli/atomiks.mjs custom_fields.groups --json '{"entityType":"leads"}'

MCP: ferramenta custom_fields_groups com a mesma entrada.

Saída

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

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