PATCH /accounts/{accountId}

Atualiza display_name / signature_html

Access: Signed in
Service: https://mail-api.axuz.net

Accepted authentication

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.

Parameters

Name	In	Type	Required	Description
`accountId`	path	`string`	yes

Request body

application/json · Required

Name	Type	Required	Description
`display_name`	`string`	no
`signature_html`	`string`	no

{
  "display_name": "string",
  "signature_html": "string"
}

Responses

200
Conta atualizada

Name	Type	Required
`id`	`string<uuid>`	yes
`user_id`	`string<uuid>`	yes
`team_id`	`oneOf`	no
`email`	`string<email>`	yes
`display_name`	`string`	no
`signature_html`	`string`	no
`created_at`	`string<date-time>`	yes

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.

Name	Type	Required	Description
`error`	`string`	yes

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

Name	Type	Required	Description
`error`	`string`	yes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

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())

PATCH /accounts/{accountId}

Accepted authentication

Parameters

Request body

Responses

200 Conta atualizada

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.

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