Broadcasts

List broadcast recipients

Get recipients for a specific broadcast.

get/orgs/broadcasts/{broadcast_id}/recipients

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/broadcasts/{broadcast_id}/recipients
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

Broadcast ID

Query parameters

status'ALL' | 'QUEUED' | 'SENDING' | 'PROCESSED' | 'SENT' | 'FAILED' | 'SKIPPED'

Only deliveries in this status.

is_skippedboolean
is_failedboolean
is_bouncedboolean
is_sentboolean
is_deliveredboolean
is_complainedboolean
is_unsubscribedboolean
is_openedboolean
is_playedboolean
is_clickedboolean
clicked_linkstring
error_reasonstring
channel_typestring

Only deliveries on this channel type, e.g. 'whatsapp_bot'.

contact_idstring

Only deliveries to this contact.

user_idstring
usernamestring
emailstring

Only deliveries to this email address.

searchstring

Search recipients by name, email, phone or username.

from_datestring date-time nullable

Only deliveries created at or after this ISO 8601 date.

to_datestring date-time nullable

Only deliveries created at or before this ISO 8601 date.

sort_field'created_at' | 'updated_at'

Field to sort broadcast recipients by

sort_direction'asc' | 'desc'

Direction to sort broadcast recipients by

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required
broadcast_idstring required
broadcast_namestring required
template_idstring nullable required
channel_type'internal' | 'org' | 'agent' | 'custom' | 'whatsapp_bot' | 'messenger_bot' | 'instagram_dm' | 'tiktok_dm' | 'telegram_bot' | 'slack_bot' | 'teams_bot' | 'gmail' | 'outlook' | 'twilio' | 'telnyx' | 'email' | 'smpp' required

The channel type

user_idstring nullable required
namestring nullable required
usernamestring nullable required
phonestring nullable required
emailstring nullable required
status'QUEUED' | 'SENDING' | 'PROCESSED' | 'SENT' | 'FAILED' | 'SKIPPED' required

The status of the broadcast recipient

source'API' | 'MANUAL' | 'INBOX' | 'IMPORT' | 'null' nullable required

How the recipient was triggered (transactional only)

payloadobject nullable required
retriesnumber required
is_skippedboolean nullable required
is_skipped_atstring date-time nullable required
is_failedboolean nullable required
is_failed_atstring date-time nullable required
is_bouncedboolean nullable required
is_bounced_atstring date-time nullable required
is_sentboolean nullable required
is_sent_atstring date-time nullable required
is_deliveredboolean nullable required
is_delivered_atstring date-time nullable required
is_complainedboolean nullable required
is_complained_atstring date-time nullable required
is_unsubscribedboolean nullable required
is_unsubscribed_atstring date-time nullable required
is_openedboolean nullable required
is_opened_atstring date-time nullable required
is_playedboolean nullable required
is_played_atstring date-time nullable required
error_messagestring nullable required
external_message_idstring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.