Campaigns

Retrieve a campaign

Retrieve a single campaign by id, including its status, targeting, content references, and schedule. To see the individual emails a sent campaign produced, filter List sent emails by campaign_id; for a pre-send readiness report, use Validate a campaign. Requires the campaigns:read capability.

get/email/campaigns/{id}

Request

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

Response

The campaign.

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.