Pular para o conteúdo
adaptmailAPI
Português (Brasil)

Configurações da caixa de correio

API 0.16.0OpenAPIllms-full.txt
PATCH/v1/mailboxes/{mailbox_id}

Use /v1 para alterar name, password e signature. Altere a cota compartilhada quota_mb no painel da hospedagem. Os arquivos não têm cota separada. Idempotency-Key é opcional, mas recomendado para novas tentativas.

Áreas de autorização e acesso · Erros e repetições

Solicitar

Janela do terminal
curl -X PATCH 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"name":"Support","signature":"Support team"}'

Opções

mailbox_idpathNecessariamente

integer

X-Customer-IDheader
Opção 1

string

Opção 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

Solicitar corpo · application/json

object

name
Opção 1

string

minLength: 1

maxLength: 120

Opção 2

null

quota_mb
Opção 1

integer

minimum: 10240

Opção 2

null

file_quota_mb
Opção 1

integer

minimum: 256

maximum: 512000

Opção 2

null

password
Opção 1

string

minLength: 12

maxLength: 128

Opção 2

null

signature
Opção 1

string

maxLength: 5000

Opção 2

null

Campos desconhecidos não são aceitos.

Respostas

202 Resposta bem-sucedida

application/json

object

id

string · uuid

ID da operação para verificar o status e cancelar um envio pendente.

kind

string

mailbox_id
Opção 1

integer

Opção 2

null

status

string

Valores válidos: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

created_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

completed_at
Opção 1

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

Opção 2

null

error

O motivo do erro se a operação não foi concluída com êxito.

Opção 1

string

Opção 2

null

result

O resultado da operação. Para envio, contém informações sobre destinatários aceitos e rejeitados.

Opção 1

object

Opção 2

null

400 Cabeçalho ou identificador inválido

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

401 Login necessário

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

403 Sem acesso

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

404 Recurso não encontrado

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

409 Conflito de estado

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

422 Erro de validação

application/json

object

detail

array

Elementos da matriz

object

locNecessariamente

array

Elementos da matriz
Opção 1

string

Opção 2

integer

msgNecessariamente

string

typeNecessariamente

string

503 Indisponibilidade temporária

application/json

object

detail
Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object