Sign in
Campaigns

Retrieve a campaign

get/campaigns/{id}

Path parameters

idstring required

The ID of the campaign

Response

A Campaign object

idstring required

The ID of the campaign

created_atstring required

The time when the campaign was created in ISO 8601 format

updated_atstring required

The time when the campaign was last updated in ISO 8601 format

businessstring nullable required

The ID of the business

namestring required

The name of the campaign

enrolled_customersstring[]

The customers enrolled in the campaign

enrolled_customer_idsstring[]

The IDs of the customers enrolled in the campaign

segmentstring nullable required

The segment attached to the campaign

email_addressstring nullable required

The email address used to send emails in the campaign. Will be the ID of an email-like object

phone_numberstring nullable required

The phone number used to send SMS messages in the campaign. Will be the ID of a phone number-like object

status'draft' | 'scheduled' | 'started' | 'stopped' | 'finished' required

The status of the campaign.

scheduled_atstring nullable required

The time when the campaign is scheduled to start in ISO 8601 format

scheduled_end_atstring nullable required

The time when the campaign is scheduled to end in ISO 8601 format

attributed_revenuestring nullable required

The revenue attributed to the campaign

metadataobject required

Arbitrary metadata associated with this campaign

Changes