Schedule a campaign

post

https://api.delivr.to/campaign

Schedule a new campaign

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

start_epoch

string

Epoch time for the campaign to start

template_id

string

required

The ID of the template on which the campaign is based

campaign_name

string

required

The name to give to the campaign

recipient

string

required

The recipient email address for the campaign

delay

string

The delay in seconds between each email

expiry

string

The lifetime of any links generated for the campaign, in minutes (default is 60, maximum is 1440)

include_disabled_integrations

boolean

Override the disabled status of any relevant integrations and include them in results analysis.

prefix

string

The prefix to add to each send email subject

as_attachments

boolean

An optional override to send the payloads specified in selected_payloads as attachments, without needing to specify it on a per-payload basis.

as_links

boolean

An optional override to send the payloads specified in selected_payloads as links, without needing to specify it on a per-payload basis.

as_body

boolean

An optional override to send the payloads specified in selected_payloads as body, without needing to specify it on a per-payload basis.

provider

string

The email provider to use to send the campaign emails

email_results

boolean

Whether to email a summary of the results to the requestor's primary email address, default is true

repeat

object

Configuration for repeating campaigns

selected_payloads

array of objects

A list of objects representing a payload and its requested delivery methods, i.e. link, attachment, or body. If not provided, all payloads from the template will be sent in all their supported methods.

selected_payloads

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response for scheduling a campaign