API Data Provider - Online Help

Broadcasts

List all broadcasts of your account

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A read-only Drip generated unique id used to identify each broadcast record.

AccountId String False

Accounts.Id

The account Id.

Status String True

Returns whether the broadcast is draft, canceled, scheduled, sent or sending. When used for filtering, filter by one of the following statuses: draft, scheduled, or sent. Defaults to all.

The allowed values are draft, scheduled, sent.

Name String False

The private name given to the broadcast.

FromName String True

A 'from name' that appears in your sent emails and can be changed on a per email basis. This setting overrides the account's default from name.

FromEmail String True

A 'from email' that appears in your sent emails and can be changed on a per email basis. This setting overrides the account's default from email.

PostalAddress String False

As required by the CAN-SPAM Act, this is a postal address used for all sent emails and can be changed on a per email basis.

LocalizeSendingTime Boolean True

The scheduled send_at time if set to be sent in the subscriber's time zone.

SendAt Datetime True

The timestamp representing when the broadcast will be delivered.

Bcc String True

A list of emails designated to receive a blind copy of the broadcast.

CreatedAt Datetime True

A read-only Drip generated timestamp for when the broadcast was first created.

Href String True

The url designated for retrieving the account record via the REST API.

Subject String False

The broadcast email's subject.

HtmlBody String False

The HTML content used in the email's body.

TextBody String False

The plain text content used in the email's body.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0