Ir al contenido
adaptmailAPI
Español

enviar una carta

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

Requerido Idempotency-Key Entre 8 y 128 caracteres. Repetir con la misma clave y cuerpo devuelve la misma operación; otro cuerpo da 409. HTTP 202 significa hacer cola. Verifica el estado de la operación, no el hecho de que se haya recibido respuesta.

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

Pedido

Ventana de terminal
curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}'

Opciones

mailbox_idpathNecesariamente

integer

X-Customer-IDheader
Opción 1

string

Opción 2

null

Idempotency-KeyheaderNecesariamente

string

minLength: 8

maxLength: 128

Cuerpo de la solicitud · application/json

object

toNecesariamente

array

Direcciones de los principales destinatarios.

minItems: 1

maxItems: 50

elementos de matriz

string

cc

array

Copie las direcciones de los destinatarios que sean visibles para otros participantes.

maxItems: 50

elementos de matriz

string

bcc

array

Direcciones de destinatarios en Cco.

maxItems: 50

elementos de matriz

string

subject

string

Asunto de la carta.

Por defecto: ""

maxLength: 998

text

string

El texto de la carta sin formato.

Por defecto: ""

maxLength: 200000

html

HTML-versión formateada de la carta.

Opción 1

string

maxLength: 300000

Opción 2

null

file_ids

array

ID archivos descargados previamente en este buzón. Consíguelos al descargar o de la lista de archivos.

maxItems: 20

elementos de matriz

string · uuid

forward_message

El correo electrónico original cuyos archivos adjuntos deben reenviarse.

Opción 1

object

folderNecesariamente

string

Nombre de carpeta de la lista de carpetas, por ejemplo INBOX.

minLength: 1

maxLength: 255

uidvalidityNecesariamente

integer

El valor es uidvalidity de la respuesta API para esta carpeta.

exclusiveMinimum: 0

uidNecesariamente

integer

exclusiveMinimum: 0

No se aceptan campos desconocidos.

Opción 2

null

reply_to_message_id

El valor message_id del correo electrónico al que estás respondiendo.

Opción 1

string

maxLength: 998

Opción 2

null

references

El valor references del mensaje original para guardar la cadena de respuesta.

Opción 1

string

maxLength: 4000

Opción 2

null

send_at

Hora de envío retrasada con zona horaria, por ejemplo 2026-11-01T12:00:00Z. Sin un valor, el envío comienza a medida que se procesa la cola.

Opción 1

string · date-time

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

413 Tamaño excedido

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

Resultado de envío exitoso

Los campos result de la operación son posteriores a la ejecución, no a la respuesta a la cola.

object

message_id

string

smtp_accepted

boolean

sent_saved

boolean

accepted_recipients

array

elementos de matriz

string

rejected_recipients

array

elementos de matriz

object

email

string

code

integer