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 URI

URL of first image after the logo.


snapshotImageUrlstringformat URI

URL of the landing page snapshot.


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.

Was this helpful?
Yes
No