AtomiksAPI
Ver .md

inbox.settings_get

Ver configurações do atendimento. Configurações da caixa: restringir atendentes a conversas livres e próprias, encerramento automático por inatividade (minutos, null desligado) e aparência (presets do balão enviado e do fundo). Sem registro, devolve os padrões.

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

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.settings_get --json '{}'

MCP: ferramenta inbox_settings_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "restrictToFreeAndOwn": {
      "type": "boolean"
    },
    "autoCloseMinutes": {
      "type": [
        "number",
        "null"
      ]
    },
    "appearance": {
      "type": "object",
      "properties": {
        "sentBubble": {
          "type": "object",
          "properties": {
            "whatsapp": {
              "type": "string",
              "enum": [
                "default",
                "accent",
                "graphite",
                "sky",
                "sand"
              ]
            },
            "other": {
              "type": "string",
              "enum": [
                "default",
                "accent",
                "graphite",
                "sky",
                "sand"
              ]
            }
          },
          "required": [
            "whatsapp",
            "other"
          ],
          "additionalProperties": false
        },
        "background": {
          "type": "string",
          "enum": [
            "none",
            "pattern",
            "solid"
          ]
        }
      },
      "required": [
        "sentBubble",
        "background"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "restrictToFreeAndOwn",
    "autoCloseMinutes",
    "appearance"
  ],
  "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).