Create a report schedule recipient

Módulo Reports

POST/report-schedule-recipientsreportScheduleRecipients.create

A member of the org a scheduled report is emailed to; each receives it run with their own access, so a report never leaves the org (Section 4.6.4). Creates a report schedule recipient. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad reports.schedule.write.
Alcances de OAuth: reports.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ReportScheduleRecipientCreate

reportScheduleRecipients.create: ReportScheduleRecipientCreate
Campo	Tipo	Obligatorio	Descripción
report_schedule_id	string (uuid)	Sí	Identifier of the report schedule.
membership_id	string (uuid)	Sí	Identifier of the membership of the recipient, in the schedule's org.

{
  "report_schedule_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: ReportScheduleRecipient

reportScheduleRecipients.create: ReportScheduleRecipient
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the report schedule recipient.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
report_schedule_id	string (uuid)	Sí	Identifier of the report schedule.
membership_id	string (uuid)	Sí	Identifier of the membership of the recipient, in the schedule's org.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "report_schedule_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/report-schedule-recipients" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"report_schedule_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.reportScheduleRecipients.create({
    "report_schedule_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.report_schedule_recipients.create({"report_schedule_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos report-schedule-recipients create --data '{"report_schedule_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'