Campaign App Pushes

Description

Campaing Apps are pushed in plain json in array of elements as presented in the example below. Integration of type CampaignApp has to be created. Pushes are triggered on Create and Update of given Campaign App or editing its settings. Array contains always single element of Campaign App Patch:

Fields

Campaign App Patch

Campaign App

Name	Description	Type/Supported Values
id	Id of the CampaginApp	long
guid	CampaignApp unique identifier	guid
tenantId	Id of the organization	long
visualType	Visual Type of the CampaignApp	string
campaignAppTypeName	Name of the CampaignApp Type	string
fromDateTime	CampaignApp from date	datetime
toDateTime	CampaignApp to date	datetime
status	CampaignApp status	string [planning, running, ended, archived]
isPubliclyPromoted	A boolean value which is true if the CampaignApp is promoted	boolean
settings	CampaignApp settings	JSON object
contentType	Patch Content	string [CampaignApp]

Example

plain json

[
    {
       "operation":"replace",
       "eventTime":"2024-06-19T05:37:27.681592Z",
       "value":{
          "Id":123,
          "Guid":"5745e72f-5ffd-4927-aa6c-980c28387c05",
          "ContentType":"CampaignApp",
          "TenantId":123,
          "VisualType":"advancedForm",
          "CampaignAppTypeName":"AdvancedForm",
          "FromDateTime":"2023-09-18T13:45:34.590734Z",
          "ToDateTime":"9999-12-31T23:59:59.9999999",
          "Status":"running",
          "IsPubliclyPromoted":true,
          "Settings":{
             "submissionFromDateTime":"2023-09-29T19:00:27.000Z",
             "submissionToDateTime":null,
             "shrinkLargeImages":"true",
             "isSubmissionCounterVisible":"false",
             "globalSubmissionLimit":null,
             "backgroundColor":"#F2F2F2",
             "backgroundSizing":null,
             "backgroundRepeat":null,
             "backgroundAttachment":null,
             "backgroundPosition":null,
             "sponsorLogoUrl":null,
             "customJs":null,
             "customCss":null,
             "customTranslations":null,
             "termsAndConditions":null,
             "fontSize":"14px",
             "topBannerUrl":null,
             "postParticipationContent":null,
             "canParticipantWinMultipleTimes":"false",
             "showPrizesPanel":"false",
             "openPrizesPanelByDefault":"false",
             "headerImage":null,
             "backgroundImage":null,
             "sponsorLogoImage":null,
             "topBannerImage":null,
             "mobileAuthSenderName":"Fandrive",
             "authenticationDescription":null,
             "headerBackgroundColor":"#FFFFFF",
             "emailNotificationSender":"ApiDoc",
             "customerGoogleAnalyticsId":null,
             "customerFacebookPixelId":null,
             "hasCustomerGoogleAnalyticsTracker":null,
             "hasCustomerFacebookPixelTracker":null,
             "termsExpanding":"false",
             "additionalLanguages":"[]",
             "showLanguageFlag":"true",
             "showShareButton":"true",
             "customCssMicroLiveApp":null,
             "customJsMicroLiveApp":null,
             "styleCssMicroLiveApp":"00000000-0000-0000-0000-000000000000",
             "styleCssXLiveApp":"00000000-0000-0000-0000-000000000000",
             "leaderboardTimestamp":null,
             "mobileAuthTokenMessage":null,
             "phoneAuthenticationFields":"[{\"id\":\"nickName\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"text\"},{\"id\":\"email\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"isMandatory\":true,\"type\":\"email\"},{\"id\":\"streetAddress\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"text\"},{\"id\":\"postalCode\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"text\"},{\"id\":\"city\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"text\"},{\"id\":\"country\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"text\"},{\"id\":\"phoneNumber\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"tel\"},{\"id\":\"gender\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"option\"},{\"id\":\"dateOfBirth\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"dateTime\"},{\"id\":\"ageVerification\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"isMandatory\":false,\"type\":\"checkbox\"},{\"id\":\"termsVerification\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"isMandatory\":false,\"type\":\"checkbox\"},{\"id\":\"consentTextIds\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"isMandatory\":true,\"type\":\"hidden\"}]",
             "leaderboardPreset":"{\"minValue\":0.0,\"maxValue\":10.0,\"includeInLeaderboards\":false}",
             "canParticipateMultipleTimes":"true",
             "postParticipationActionCaption":"ApiDoc Thank you",
             "textColor":"#005C38",
             "externalTitle":"ApiDoc Title",
             "primaryColor":"#005C38",
             "externalDescription":"<div style=\"text-align: center;\">[Opti Doc]</div>",
             "postParticipationActionLink":"https://api.doc",
             "headerTextColor":"#005C38",
             "authenticationFields":"[{\"id\":\"fullName\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"firstName\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"lastName\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"nickName\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"email\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"email\",\"isMandatory\":true},{\"id\":\"streetAddress\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"postalCode\",\"isEnabled\":true,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"city\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"country\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"text\",\"isMandatory\":false},{\"id\":\"phoneNumber\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"tel\",\"isMandatory\":false},{\"id\":\"gender\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"option\",\"isMandatory\":false},{\"id\":\"dateOfBirth\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"dateTime\",\"isMandatory\":false},{\"id\":\"ageVerification\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"checkbox\",\"isMandatory\":false},{\"id\":\"custom-SMS Kamerater-tipset\",\"isEnabled\":false,\"isRequired\":false,\"customLabel\":null,\"type\":\"tel\",\"isMandatory\":false},{\"id\":\"termsVerification\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"checkbox\",\"isMandatory\":false},{\"id\":\"consentTextIds\",\"isEnabled\":true,\"isRequired\":true,\"customLabel\":null,\"type\":\"hidden\",\"isMandatory\":true}]",
             "smsNotificationSender":"ApiDoc"
          }
       }
    }
 ]