Probar el correo de confirmación

POST /api/v1/settings/optin/test-send Envía el correo de confirmación a una dirección que elijas, con un enlace que no confirma a nadie. Requiere el rol Admin.

Una prueba es un envío real. Pasa por las mismas protecciones que una campaña y cuenta en tu cuota de envío. No escribe ninguna estadística.

Autorización

Rol en la organización	Este endpoint
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Rechazado — `403`

Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Cuerpo de la solicitud

Campo	Tipo	Obligatorio	Descripción
`email`	string	sí	Adónde entregar la prueba
`subject`	string	no	Prueba un asunto sin guardarlo
`content`	string	no	Prueba un cuerpo HTML sin guardarlo

Ejemplo

bash

curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com"}' \
  "https://www.agentsmail.io/api/v1/settings/optin/test-send"

Respuesta

200 OK: la llamada tuvo éxito.
400 Bad Request: la validación falló; details lleva los problemas campo por campo.
401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
403 Forbidden: el propietario de la clave es member de la organización, no admin.
429 Too Many Requests: más de 120 peticiones en un minuto para esta clave.

Campos de la respuesta

Estados de rechazo: blocked (envío en pausa en todo AgentsMail), not_allowed (organización no autorizada, o dominio no verificado), skipped (nada que enviar).

Campo	Tipo	Descripción
`success`	boolean	Indica si la operación tuvo éxito
`data.status`	string	`sent`, o el motivo por el que no salió

Ejemplo de respuesta

json

{"success": true, "data": {"status": "sent"}}