Campaigns

Send a campaign

Validate a campaign and then send it — immediately, or at its scheduled_at if one is set. If anything blocks the send (unverified domain, missing template variables, empty audience, …) you get a 409 with each blocking reason itemized in error.details[]. To see the full pre-send report without attempting a send, use Validate a campaign; fix variable issues via Update a campaign. A launched campaign can be paused or canceled. Requires the campaigns:send capability.

post/email/campaigns/{id}/send

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/campaigns/{id}/send
  • Auth: HTTP bearer

Response

The campaign (now scheduled/sending).

object'campaign' required
idstring required
namestring required
template_idstring required
segment_idstring required
topic_idstring nullable required
fromstring required
subjectstring nullable required
preview_textstring nullable required
open_trackingboolean nullable required
click_trackingboolean nullable required
status'draft' | 'scheduled' | 'sending' | 'paused' | 'sent' | 'canceled' | 'failed' required
scheduled_atstring nullable required
variable_fallbacksobject required
excluded_contact_idsstring[] required
total_recipientsnumber required
sent_countnumber required
failed_countnumber required
created_atstring required
updated_atstring required

Changes

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