email_inbox.sync_now

Ler a caixa de e-mail agora. Faz uma rodada de leitura da caixa na hora (o worker faz isso a cada minuto) e devolve quantas mensagens novas entraram no atendimento e o estado do canal. Se o servidor de e-mail recusar, a caixa passa a "falhando" (emailFailingSince, emailLastErrorCode) e a resposta traz failing: true. more: true = ainda há mensagens para ler (chame de novo).

• Endpoint: POST https://app.atomiks.com.br/api/v1/email_inbox.sync_now (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: channels:write
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: email_inbox_sync_now
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId email_inbox.sync_now)

Entrada

{
  "$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)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/email_inbox.sync_now \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs email_inbox.sync_now --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta email_inbox_sync_now com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "imported": {
      "type": "number"
    },
    "more": {
      "type": "boolean"
    },
    "failing": {
      "type": "boolean"
    },
    "instance": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "channel": {
          "type": "string",
          "const": "email"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "live",
            "error",
            "archived"
          ]
        },
        "stableKey": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "emailAddress": {
          "type": "string"
        },
        "emailLastSuccessAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "emailFailingSince": {
          "type": [
            "string",
            "null"
          ]
        },
        "emailLastErrorCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "profilePhotoUrl": {
          "type": "null"
        },
        "archivedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "archivedReason": {
          "type": "null"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "channel",
        "status",
        "stableKey",
        "displayName",
        "emailAddress",
        "emailLastSuccessAt",
        "emailFailingSince",
        "emailLastErrorCode",
        "profilePhotoUrl",
        "archivedAt",
        "archivedReason",
        "createdAt",
        "updatedAt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "imported",
    "more",
    "failing",
    "instance"
  ],
  "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).