Campaign

Evaluate Campaign Targeting

Changed on

Evaluates active campaigns for given targeting parameters and returns campaign data, if there is a matching campaign.

get/v4/campaign/evaluate/

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

accountIdinteger
campaignIdstring
languagestring
medium'email' | 'web' | 'returns'
  • email - Email
  • web - Web
  • returns - Returns Portal
messagestring
orderNumberstring
previewboolean
statusstring
trackingIdstring

24-char hex MongoDB ObjectId of the tracking document

Response

campaignIdstring nullable required
trackingIdstring nullable required
customerSegmentationIdstring nullable
audienceIdstring nullable
openTrackingUrlstring
analyticsBaseUrlstring
valuesobject required
placeholdersobject required
typedValuesobject
accountHasActiveCampaignsboolean nullable required

Changes