Axuz Developers

PATCH /messages/{messageId}

Ajusta flags (read/starred/labels)

  • Acesso: Login
  • Serviço: https://mail-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— PATCH /messages/:messageId. Ajusta flags visuais (read/starred/labels). Motivo: user marca lido/estrela/label sem mover de folder. Gate: ownsAccount da mensagem. COALESCE mantém campos que o cliente omitiu.

Parâmetros

NomeEmTipoObrigatórioDescrição
messageIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
readbooleannão
starredbooleannão
labelsarray<string>não
{
  "read": true,
  "starred": true,
  "labels": [
    "string"
  ]
}

Respostas

200

Mensagem atualizada

NomeTipoObrigatórioDescrição
idstring<uuid>sim
account_idstring<uuid>sim
folder_idstring<uuid>sim
thread_idstring<uuid>sim
in_reply_tostring<uuid> | nullnão
from_emailstring<email>sim
from_namestringnão
to_emailsarray<string<email>>sim
cc_emailsarray<string<email>>não
bcc_emailsarray<string<email>>não
subjectstringsim
body_htmlstringnão

Corpo HTML sanitizado (allowlist bluemonday, internal/sanitize). Toda leitura passa pelo mesmo chokepoint (scanMessage), então este campo nunca carrega <script>, atributos on*, javascript:, <iframe>, <object> ou <svg>. A COLUNA homônima no banco guarda o corpo cru (forense) e NÃO é confiável — ela nunca sai pela API.

body_textstringnão
readbooleansim
starredbooleansim
labelsarray<string>não
received_atstring<date-time>sim
sent_atstring<date-time> | nullnão
statusstringsim

enum: "draft", "sent", "received", "queued"

internalbooleansim
created_atstring<date-time>sim
updated_atstring<date-time>sim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é dono

404

Não achada

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X PATCH 'https://mail-api.axuz.net/messages/MESSAGE_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"read":true,"starred":true,"labels":["string"]}'

Node.js

const res = await fetch("https://mail-api.axuz.net/messages/MESSAGE_ID", {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "read": true,
    "starred": true,
    "labels": [
      "string"
    ]
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "PATCH",
    "https://mail-api.axuz.net/messages/MESSAGE_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "read": True,
        "starred": True,
        "labels": [
            "string",
        ],
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())