email_inbox.update_settings

Ajustar o envio de uma caixa de e-mail. Nome do remetente (fromName, até 120 caracteres; aparece antes do endereço nos e-mails enviados), assinatura (signatureText até 2000 caracteres, com *negrito*, _itálico_, listas "- " e links; signatureLogoUrl com https) e syncSentFolder (grava na conversa o que você envia direto pelo webmail ou celular para um contato com conversa aberta; vale só do momento em que liga). Só o que for enviado muda; null ou texto vazio limpa. Devolve a configuração (mesmo formato de email_inbox.get).

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

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)$"
    },
    "fromName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "syncSentFolder": {
      "type": "boolean"
    },
    "signatureText": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ]
    },
    "signatureLogoUrl": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2048
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/email_inbox.update_settings \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","fromName":"Ana da Loja Exemplo","syncSentFolder":true}'

CLI:

node cli/atomiks.mjs email_inbox.update_settings --json '{"id":"00000000-0000-0000-0000-000000000000","fromName":"Ana da Loja Exemplo","syncSentFolder":true}'

MCP: ferramenta email_inbox_update_settings com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelInstanceId": {
      "type": "string"
    },
    "emailAddress": {
      "type": "string"
    },
    "imapHost": {
      "type": "string"
    },
    "imapPort": {
      "type": "number"
    },
    "imapSecure": {
      "type": "boolean"
    },
    "imapUsername": {
      "type": "string"
    },
    "smtpHost": {
      "type": "string"
    },
    "smtpPort": {
      "type": "number"
    },
    "smtpSecure": {
      "type": "boolean"
    },
    "smtpUsername": {
      "type": "string"
    },
    "lastSuccessAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "failingSince": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastErrorCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastError": {
      "type": [
        "string",
        "null"
      ]
    },
    "consecutiveFailures": {
      "type": "number"
    },
    "fromName": {
      "type": [
        "string",
        "null"
      ]
    },
    "syncSentFolder": {
      "type": "boolean"
    },
    "signatureText": {
      "type": [
        "string",
        "null"
      ]
    },
    "signatureLogoUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "historyImport": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "since": {
              "type": "string"
            },
            "total": {
              "type": [
                "number",
                "null"
              ]
            },
            "processed": {
              "type": "number"
            },
            "completedAt": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "since",
            "total",
            "processed",
            "completedAt"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string"
    }
  },
  "required": [
    "channelInstanceId",
    "emailAddress",
    "imapHost",
    "imapPort",
    "imapSecure",
    "imapUsername",
    "smtpHost",
    "smtpPort",
    "smtpSecure",
    "smtpUsername",
    "lastSuccessAt",
    "failingSince",
    "lastErrorCode",
    "lastError",
    "consecutiveFailures",
    "fromName",
    "syncSentFolder",
    "signatureText",
    "signatureLogoUrl",
    "historyImport",
    "createdAt"
  ],
  "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).