Ver .md

me.view_prefs_set

Salvar minhas preferências de tela. Substitui as preferências do próprio usuário para a tela, na conta atual. Restaurar o padrão das colunas = columns: null. contacts.columns aceita os ids do catálogo e cf:{customFieldId} (até 20), sem repetir.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/me.view_prefs_set (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: contacts:read
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: me_view_prefs_set
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId me.view_prefs_set)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "view": {
          "type": "string",
          "const": "contacts"
        },
        "prefs": {
          "type": "object",
          "properties": {
            "columns": {
              "anyOf": [
                {
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "null"
                }
              ]
            },
            "perPage": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 20
                },
                {
                  "type": "number",
                  "const": 50
                },
                {
                  "type": "number",
                  "const": 100
                }
              ]
            }
          },
          "required": [
            "columns"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "view",
        "prefs"
      ]
    }
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/me.view_prefs_set \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"view":"contacts","prefs":{"columns":["contact","tags","email","phone"],"perPage":50}}'

CLI:

node cli/atomiks.mjs me.view_prefs_set --json '{"view":"contacts","prefs":{"columns":["contact","tags","email","phone"],"perPage":50}}'

MCP: ferramenta me_view_prefs_set com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "view": {
          "type": "string",
          "const": "contacts"
        },
        "prefs": {
          "type": "object",
          "properties": {
            "columns": {
              "anyOf": [
                {
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "null"
                }
              ]
            },
            "perPage": {
              "anyOf": [
                {
                  "type": "number",
                  "const": 20
                },
                {
                  "type": "number",
                  "const": 50
                },
                {
                  "type": "number",
                  "const": 100
                }
              ]
            }
          },
          "required": [
            "columns"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "view",
        "prefs"
      ],
      "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).