Ver .md

email_inbox.update_credentials

Trocar a senha de uma caixa de e-mail. Testa a nova senha (recebimento e envio, com os servidores já salvos) e só então a guarda cifrada. Se o teste falhar nada é salvo e saved vem false, com o motivo em result. Ao salvar, o estado "falhando" é limpo e a leitura recomeça. A senha nunca volta.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
imapPasswordstringsim
smtpPasswordstringsim
JSON Schema
{
  "$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)$"
    },
    "imapPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    },
    "smtpPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024
    }
  },
  "required": [
    "id",
    "imapPassword",
    "smtpPassword"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs email_inbox.update_credentials --json '{"id":"00000000-0000-0000-0000-000000000000","imapPassword":"nova-senha-de-app","smtpPassword":"nova-senha-de-app"}'

MCP: ferramenta email_inbox_update_credentials com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "imap": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            },
            "errorCode": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "ok",
            "errorCode"
          ],
          "additionalProperties": false
        },
        "smtp": {
          "type": "object",
          "properties": {
            "ok": {
              "type": "boolean"
            },
            "errorCode": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "ok",
            "errorCode"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "imap",
        "smtp"
      ],
      "additionalProperties": false
    },
    "saved": {
      "type": "boolean"
    }
  },
  "required": [
    "result",
    "saved"
  ],
  "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).