Enviar recordatorio a un invitado

POST /rest/v1/events/{eventId}/guests/{eventGuestId}/reminders

Envía un correo de recordatorio para un solo registro de invitado. Usa las mismas plantillas que los recordatorios programados y manuales, e incluye un enlace de cancelar registro válido para ese invitado.

Requiere el alcance reminders:send. Consulta Autenticación para encabezados, límites y el formato de error compartido.

Esto envía un correo real. Úsalo para probar de punta a punta el recordatorio y la cancelación del boleto. No notifica a otros invitados y no inicia el periodo de espera de 7 días del envío masivo manual.

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
eventId	UUID string	Sí	Evento dueño del registro.
eventGuestId	UUID string	Sí	Id de la fila evento–invitado (eventGuestId de Listar invitados del evento).

La organización viene de la clave de API. El evento y el invitado deben pertenecer a esa organización. Los registros cancelados se tratan como no encontrados.

Cuerpo de la petición

Envía JSON. Un cuerpo vacío está permitido y usa un recordatorio manual a la dirección del invitado.

Campo	Tipo	Requerido	Predeterminado	Descripción
reminderType	string	No	manual	one_week, one_day, event_day, manual o open_spot.
to	string	No	email del invitado	Dirección opcional para pruebas. El enlace de cancelación sigue apuntando a este eventGuestId.

Se recomienda Content-Type: application/json cuando envías un cuerpo.

Ejemplo

curl -X POST "https://wehabit.mx/rest/v1/events/{eventId}/guests/{eventGuestId}/reminders" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"reminderType":"one_day","to":"qa@example.com"}'

Respuesta 200

{
  "data": {
    "eventGuestId": "8c7e9f2a-1234-4567-89ab-123456789abc",
    "eventId": "7f4c1b2e-8e9b-4e31-9c1d-123456789abc",
    "reminderType": "one_day",
    "to": "qa@example.com",
    "cancelUrlIncluded": true
  }
}

Campo	Tipo	Descripción
eventGuestId	string	Registro al que se envió el correo.
eventId	string	Id del evento.
reminderType	string	Plantilla enviada.
to	string	Dirección que recibió el correo.
cancelUrlIncluded	boolean	true cuando se incluyó el enlace de cancelación.

Errores

Los códigos compartidos están en Autenticación. Estos son específicos de esta ruta:

400 cuerpo inválido

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "One or more fields are invalid.",
    "details": {
      "reminderType": "Must be one_week, one_day, event_day, manual, or open_spot.",
      "to": "Must be a valid email address."
    }
  }
}

403 alcance faltante

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The API key does not have permission to send reminders."
  }
}

404 invitado o evento desconocido

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested guest registration was not found."
  }
}

409 evento en borrador

{
  "error": {
    "code": "EVENT_DRAFT",
    "message": "Publish the event before sending a reminder."
  }
}

405 otros métodos

Solo se permite POST. La respuesta incluye Allow: POST.