Axuz Developers

PATCH /accounts/{accountId}

Atualiza display_name / signature_html

  • 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`.

Nome e signature são mutáveis. Email e team_id são imutáveis nesta fase. Gate: dono da conta.

Parâmetros

NomeEmTipoObrigatórioDescrição
accountIdpathstringsim

Corpo da requisição

application/json · Obrigatório

NomeTipoObrigatórioDescrição
display_namestringnão
signature_htmlstringnão
{
  "display_name": "string",
  "signature_html": "string"
}

Respostas

200

Conta atualizada

NomeTipoObrigatórioDescrição
idstring<uuid>sim
user_idstring<uuid>sim
team_idoneOfnão
emailstring<email>sim
display_namestringnão
signature_htmlstringnão
created_atstring<date-time>sim

400

Payload malformado

401

Sessão inválida

403

Não é dono da conta

404

Conta 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/accounts/ACCOUNT_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"string","signature_html":"string"}'

Node.js

const res = await fetch("https://mail-api.axuz.net/accounts/ACCOUNT_ID", {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "display_name": "string",
    "signature_html": "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/accounts/ACCOUNT_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "display_name": "string",
        "signature_html": "string",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())