broadcasts

The recipients of a broadcast for one event type: sent, delivered, opened, clicked, bounced, complained, unsubscribed or suppressed.

opened and clicked rows carry count, clicked rows carry clicked_links, bounced rows carry bounce_type. unsubscribed is always empty, because an unsubscribe is recorded against the contact, not against the message that carried the link.

get/broadcasts/{id}/recipients

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/broadcasts/{id}/recipients
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

type'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed' required

The event to filter recipients by.

emailstring

Keep recipients whose email address contains this value.

bounce_type'permanent' | 'transient' | 'undetermined'

Keep bounced recipients of this bounce type. Only with type=bounced.

limitinteger

Between 1 and 100. Defaults to 20.

afterstring

The id of the last row of the previous page. Not with before.

beforestring

The id of the first row of the next page. Not with after.

Response

Success

object'list' required
has_moreboolean required

Changes

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