Campaign Object

Properties
campaignIdstringformat GUID

Campaign ID.

titlestring

Marketing campaign title. For sent campaigns this will match the email subject if subject was not explicitly provided on sending. For published campaigns - the title will be the first line of text.

firstImageUrlstringformat WEB_URL

URL of the first image after the logo.

snapshotImageUrlstringdeprecated - use firstImageUrl insteadformat WEB_URL

Landing page snapshot URL.
This field is deprecated and snapshot images are no longer supported. Instead, use the firstImageUrl field. The value of this field will soon become the same as the value of the firstImageUrl field.

editorTypestring
3 enum supported values:
UNKNOWNWEBMOBILE

Editor type. Either web app, or mobile app.

statusstring
4 enum supported values:
UNKNOWNACTIVEARCHIVEDDELETED

Campaign status.

visibilityStatusstring
4 enum supported values:
UNKNOWNDRAFTPUBLISHEDTEMPLATE

Campaign visibility status.

distributionStatusstring
11 enum supported values:
UNKNOWNNOT_STARTEDSCHEDULEDIN_DETECTIONIN_MODERATIONSAMPLINGSENDINGREJECTEDTERMINATEDDISTRIBUTEDPAUSED

Campaign distribution status.

publishingDataobject

Publishing data (present only if campaign is published).

dateCreatedstringformat date-time

Campaign creation date.

dateUpdatedstringformat date-time

Campaign last update date.

emailSubjectstringdeprecatedmaxLength 1000

Email subject of the campaign (initially copied from the template). TODO: Deprecated (moved to "GetComposerResponse").

Was this helpful?
Yes
No