Ir al contenido
adaptmailAPI
Español

Configuración del buzón

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

Use /v1 para cambiar name, password y signature. Cambie la cuota compartida quota_mb desde el panel de su proveedor. Los archivos no tienen una cuota independiente. Idempotency-Key es opcional, pero se recomienda para los reintentos.

Zonas de autorización y acceso · Errores y repeticiones.

Pedido

Ventana de 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"}'

Opciones

mailbox_idpathNecesariamente

integer

X-Customer-IDheader
Opción 1

string

Opción 2

null

Idempotency-Keyheader

string

minLength: 8

maxLength: 128

Cuerpo de la solicitud · application/json

object

name
Opción 1

string

minLength: 1

maxLength: 120

Opción 2

null

quota_mb
Opción 1

integer

minimum: 10240

Opción 2

null

file_quota_mb
Opción 1

integer

minimum: 256

maximum: 512000

Opción 2

null

password
Opción 1

string

minLength: 12

maxLength: 128

Opción 2

null

signature
Opción 1

string

maxLength: 5000

Opción 2

null

No se aceptan campos desconocidos.

Respuestas

202 Respuesta exitosa

application/json

object

id

string · uuid

ID de operación para verificar el estado y cancelar un envío pendiente.

kind

string

mailbox_id
Opción 1

integer

Opción 2

null

status

string

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

run_at

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

created_at

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

completed_at
Opción 1

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

Opción 2

null

error

El motivo del error si la operación no se completó correctamente.

Opción 1

string

Opción 2

null

result

El resultado de la operación. Para envío, contiene información sobre los destinatarios aceptados y rechazados.

Opción 1

object

Opción 2

null

400 Encabezado o identificador no válido

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

401 Iniciar sesión requerido

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

403 Sin acceso

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

404 Recurso no encontrado

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

409 Conflicto de estado

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

422 Error de validación

application/json

object

detail

array

elementos de matriz

object

locNecesariamente

array

elementos de matriz
Opción 1

string

Opción 2

integer

msgNecesariamente

string

typeNecesariamente

string

503 Indisponibilidad temporal

application/json

object

detail
Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object