Create an RSS campaign

post

https://api.bigmailer.io/v1/brands/{brand_id}/rss-campaigns

Create an RSS campaign.

Path Params

brand_id

uuid

required

ID of the brand to create a campaign in

Body Params

name

string

required

Name of the campaign

subject

string

Subject line for the campaign

from

object

recipient_name

string

Name of the recipient. Use merge tags to make it more personal and avoid spam filters.

reply_to

object

link_params

string

Additional query string parameters to add to all links in the template.

preview

string

Copy shown following your subject line in many email clients.

html

string

HTML body of the email.

text

string

Text body of the email.

template_id

uuid

A template id to use to populate the HTML body of the email.

track_opens

boolean

True to enable open tracking (HTML campaigns only).

track_clicks

boolean

True to enable click tracking in HTML links.

track_text_clicks

boolean

True to enable click tracking in text links.

segment_id

uuid

ID of a segment used to filter the lists of contacts the campaign is sent to.

message_type_id

uuid

ID of the message type of the campaign.

list_ids

array of uuids

An array of list ids to send the campaign to.

list_ids

excluded_list_ids

array of uuids

An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.

excluded_list_ids

throttling_type

string

enum

Set to none to send the campaign as fast as possible. Set to burst to send the campaign in small batches over time.

Allowed:

throttling_amount

integer

1000 to 1000000

Number of emails to send in each per batch. Must be a multiple of 1000. Required if throttling_type is burst.

throttling_period

integer

enum

Time in seconds between sending each batch of emails. Required if throttling_type is burst.

Allowed:

suppression_list_id

uuid

ID of a suppression list. Any emails in the suppression list will not be sent the campaign.

feed_url

url

URL of an RSS feed.

hour

integer

0 to 23

Hour to check the RSS feed for updates.

minutes

integer

enum

Minutes to check the RSS feed for updates.

Allowed:

frequency

object

Details of how of often to check the RSS feed for updates. Only one of daily, weekly, and monthly must be present.

ready

boolean

Set to true to activate the RSS campaign. RSS campaigns will not be sent until activated by setting ready to true.

Responses

200The RSS campaign was successfully created.

400The request was invalid.

401The API key does not exist.

403The system understands the request but refuses to authorize it.

422The campaign cannot be sent in it's current state. See https://docs.bigmailer.io/docs/campaign-api-precondition-codes for more information.

429The client has made too many requests.

500An unexpected error occurred.

502The system is under heavy load or is down temporarily.

503The system is under maintenance. Please try again later.

504The system timed out processing your request.