inbox.archive

Arquivar ou desarquivar uma conversa. Tira a conversa da lista comum (archived: true) ou a devolve (false). Qualquer membro que possa escrever na conversa. Em número por QR code também arquiva no WhatsApp (melhor esforço: se o servidor do número falhar, a conversa fica arquivada só no Atomiks e synced vem false). Mensagem nova não desarquiva, como no WhatsApp.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "conversationId": {
      "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)$"
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "conversationId",
    "archived"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.archive \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"conversationId":"00000000-0000-0000-0000-000000000000","archived":true}'

CLI:

node cli/atomiks.mjs inbox.archive --json '{"conversationId":"00000000-0000-0000-0000-000000000000","archived":true}'

MCP: ferramenta inbox_archive com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "archivedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "synced": {
      "type": "boolean"
    }
  },
  "required": [
    "ok",
    "archivedAt",
    "synced"
  ],
  "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).