BroadcastRecipient

object

idrequired: Id
Opaque record id.
contactrequired: object or null
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
leadrequired: object or null
lead.idrequired: Id
Opaque record id.
lead.refrequired: string
addressrequired: string or null
Phone or email, masked by your role.
statusrequired: "queued" | "sent" | "skipped" | "cancelled"
skipped_reasonrequired: string or null
errorrequired: string or null
message_statusrequired: string or null
sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
delivered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
read_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
failed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
replied_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
clicked_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
opted_out_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "contact": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string"
  },
  "address": "string",
  "status": "queued",
  "skipped_reason": "string",
  "error": "string",
  "message_status": "string",
  "sent_at": "2026-10-06T05:30:00.000Z",
  "delivered_at": "2026-10-06T05:30:00.000Z",
  "read_at": "2026-10-06T05:30:00.000Z",
  "failed_at": "2026-10-06T05:30:00.000Z",
  "replied_at": "2026-10-06T05:30:00.000Z",
  "clicked_at": "2026-10-06T05:30:00.000Z",
  "opted_out_at": "2026-10-06T05:30:00.000Z"
}