Note: this page is for CPC and CPA/CPL campaigns only.
You can use this API using XML or JSON. Please review the appropriate section for the method you choose. We recommend that you set up the campaign default settings before using this API. The XML tags are case sensitive.
Must use a PUT method to create a campaign. Remove tags for optional fields not passed in.
*For any content that is HTML, the xml requires that it is encoded. Below is an example and a link to an HTML encoder tool that can help you encode the HTML.
Example: http://google.com?id=123&pid=34
http://www.opinionatedgeek.com/DotNet/Tools/HTMLEncode/encode.aspx
Base URL
https://api.linktrust.com/v2/Campaigns/Campaign
XML Format:
Required Values (*)
These are the minimum and required fields to create a campaign.
*Type - CPA/CPL/CPC - Required and must be all caps.
*CampaignName - Required and must be more than 1 character and less than 255 characters. & must be encoded, (&), ` must be encoded (`apos;). <, >, /, |, ~ are not allowed.
*Category - Required and must be exact match to an existing category. & must be encoded (&). Example: Computers & Electronics. <, >, /, |, ~ are not allowed.
*MerchantId - Required and must be a valid advertiser id from your account.
*DefaultLandingPageURL - Required and must be a valid url and encoded. Example: http://linktrust.com?id=1234&pid=54. 2000 character max.
Sample
<CampaignSettings>
<Campaign>
<CampaignName>gster</CampaignName>
<Type>CPA</Type>
<Category>Men</Category>
<MerchantId>100036</MerchantId>
<DefaultLandingPageURL>http://linktrust.com?id=1234&pid=54</DefaultLandingPageURL>
</Campaign>
</CampaignSettings>
Optional Values
AutoApprovePercent – 0-100. Default is none. (CPA/CPL Campaigns ONLY)
CampaignStatus - (Testing/PublicLive/PrivateLive/Paused/Dead) case sensitive. Default is Testing.
DefaultLandingPageAllowUnassignedTraffic - true or false. Default is false.
DefaultLandingPagePropagateAdditionalData - true or false. Default is false.
DefaultLandingPageHideAffiliateReferrers - true or false. Default is false.
Group - Optional and must be an exact match to an existing group. Defaults to the default campaign settings.
Revenue - Decimal values up to 4 decimal places allowed. Default is 0. Example: 1.00, 1, 10, 10.55, 10.5456.
RevenueType - Flat or Percent. Default is Flat.
DefaultAffiliatePayout - Decimal values up to 4 decimal places allowed. Default is 0. Example: 1.00, 1, 10, 10.55, 10.5456.
DefaultAffiliatePayoutType - Flat or Percent. Default is Flat. MUST be Flat if Revenue is Flat or not provided since the default Revenue is Flat.
AutoApproveTransactionForAllAffiliates - true or false. Defaults to the default campaign settings.
CampaignManagers - Must be a valid user id and included in <int></int> tags. If tags are included then you must include a value. Example:
<int>10037</int>
Affiliates - Must be a valid affiliate id and included in <int></int> tags. If tags are included then you must include a value. Example:
<int>100001</int>
<int>100003</int>
StartDate - Must be before the expiration date. Default is blank. Format: yyyy-MM-dd, 2012-10-15.
ExpirationDate - Must be after the start date. Default is blank. Format: yyyy -MM-dd, 2015-10-15.
ExpiredRedirectType - URL/Campaign/Forbidden. Defaults to the default campaign settings.
RedirectCampaignId - Must be a valid campaign ID from your account. Example: 100166. Defaults to the default campaign settings.
PropogateCookieParameter - true or false. Defaults to the default campaign settings.
PropogateTrackingParameter - true or false. Defaults to the default campaign settings.
PropogateAdditionalData - true or false. Defaults to the default campaign settings.
ExpiredRedirectUrl - Required if redirect type is set to URL. Must be a valid Url and encoded. Example: http://linktrust.com?id=1234&pid=54.
ExpiredRedirectUrlPropagateAdditionalData - true or false. Defaults to the default campaign settings.
CookieLife - Must be a whole number. Example: 0,1,2,3... Defaults to the default campaign settings. (CPA/CPL Campaigns ONLY)
Tracking - Standard/Mobile. Default is Standard. (CPA/CPL Campaigns ONLY)
AllowClickIDPostbacks - true or false. Default is true. (CPA/CPL Campaigns ONLY)
AllowAFIDPostbacks - true or false. Default is false. (CPA/CPL Campaigns ONLY)
EnablePayPerCallIntegration - true or false. Default is false. (CPA/CPL Campaigns ONLY)
AllowCookieTracking - true or false. Default is true. (CPA/CPL Campaigns ONLY)
AllowCookielessTracking - true or false. Default is true. (CPA/CPL Campaigns ONLY)
RestrictPostbackToWhitelistedIPs - true or false. Default is false. (CPA/CPL Campaigns ONLY)
AllowCustomConversionParameters - true or false. Default is false. (CPA/CPL Campaigns ONLY)
AllowExternalTransactionModifications - true or false. Default is false. (CPA/CPL Campaigns ONLY)
ExternalTransactionModificationPassword - Alphanumeric values. Required if 'Allow External Transaction Modifications' is true. Default is blank. Max 50 characters. (CPA/CPL Campaigns ONLY)
OnlyAllowModificationsFromWhitelistedIPs - true or false. Required if 'Allow External Transaction Modifications' is true. Default is false. (CPA/CPL Campaigns ONLY)
EnableProductDataFeed - true or false. Default is false. (CPA/CPL Campaigns ONLY)
IsZeroRevenueForQualifiedNotApproved - true or false. Default is false. (CPA/CPL Campaigns ONLY)
Filters
RecordOnlyUniqueImpression - true or false. Defaults to the default campaign settings.
UniqueImpressionValidValue - Must be a whole number, ie...1,2,3,4,5. Defaults to the default campaign settings.
UniqueImpressionTimeFrame - Days/Hours/Minutes. Defaults to the default campaign settings.
IfNoReferrerSetAsDuplicateClick - true or false. Defaults to the default campaign settings.
AllowDuplicateClicksByIp - true or false. Defaults to the default campaign settings.
TrackUniqueClicks - true or false. Defaults to the default campaign settings.
DuplicateClickValidValue - 3, must be a whole number. Defaults to the default campaign settings.
DuplicateClickValidTimeFrame - Days/Hours/Minutes. Defaults to the default campaign settings.
DuplicateIpRedirectType - Forbidden/Campaign/URL/LandingPage. Defaults to the default campaign settings.
Duplicate Redirect Campaign
RedirectCampaignId - Must be a valid campaign ID from your account: Example - 123456. Defaults to the default campaign settings.
PropogateCookieParameter - true or false. Defaults to the default campaign settings.
PropogateTrackingParameter - true or false. Defaults to the default campaign settings.
PropogateAdditionalData - true or false. Defaults to the default campaign settings.
DuplicateIpRedirectUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54, Defaults to the default campaign settings.
DuplicateIpRedirectUrlPropagateAdditionalData - true or false. Defaults to the default campaign settings.
DuplicateIpRedirectLandingPageWriteCookie - true or false. Defaults to the default campaign settings. (CPA/CPL Campaigns ONLY)
BlockedAffiliateRedirectType - Forbidden/Campaign/URL. Defaults to the default campaign settings.
BlockedAffiliateRedirectCampaign (ONLY INCLUDE THE CODE FOR THE TYPE SUBMITTED. FOR EXAMPLE, IF THE TYPE IS URL, REMOVE CODE FOR FORBIDDEN AND CAMPAIGN)
RedirectCampaignId - Must be a valid campaign ID from your account. Example: 123456. Defaults to the default campaign settings.
PropogateCookieParameter - true or false. Defaults to the default campaign settings.
PropogateTrackingParameter - true or false. Defaults to the default campaign settings.
PropogateAdditionalData - true or false. Defaults to the default campaign settings.
BlockedAffiliateRedirectUrl - Required if the redirect type is set to URL. Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54. Defaults to the default campaign settings.
BlockedAffiliateRedirectUrlPropagateAdditionalData - true or false. Defaults to the default campaign settings.
BlockClicksFromPublicProxies - true or false. Defaults to the default campaign settings.
TrafficCapRedirectType - Forbidden/Campaign/URL. Defaults to the default campaign settings.
Traffic Cap Redirect Campaign
RedirectCampaignId - Must be a valid campaign ID from your account. Example: 123456. Defaults to the default campaign settings.
PropogateCookieParameter - true or false. Defaults to the default campaign settings.
PropogateTrackingParameter - true or false. Defaults to the default campaign settings.
PropogateAdditionalData - true or false. Defaults to the default campaign settings.
TrafficCapRedirectUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54. Defaults to the default campaign settings.
TrafficCapRedirectUrlPropagateAdditionalData - true or false. Defaults to the default campaign settings.
Countries - Defaults to ALL countries. Example:
<string>Uganda</string>
<string>Saudi Arabia</string>
<string>Brazil</string>
UnauthorizedCountryRedirectType - Forbidden / Campaign / URL / LandingPage. Required if countries are specified.
Unauthorized Country Redirect Campaign
RedirectCampaignId - Required if type is Campaign. Must be a valid campaign ID from your account. Example: 123456.
PropogateCookieParameter - true or false. Defaults to false.
PropogateTrackingParameter - true or false. Defaults to false.
PropogateAdditionalData - true or false. Defaults to false.
UnauthorizedCountryRedirectUrl - Required if type is URL. Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54
UnauthorizedCountryRedirectUrlPropagateAdditionalData - true or false. Default is false.
UnauthorizedCountryRedirectLandingPageWriteCookie - true or false. Default is false.
CountryName - Specific unauthorized country. Example: <CountryName>Uganda</CountryName>
RedirectType - Campaign / URL. Where you wish to redirect unauthorized traffic. Example: <RedirectType>Campaign</RedirectType>
Redirect Campaign
RedirectCampaignId - Must be a valid campaign from your account. Example: 123456
PropogateCookieParameter - true or false. Default is false.
PropogateTrackingParameter - true or false. Default is false.
PropogateAdditionalData - true or false. Default is false.
RedirectUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54.
RedirectUrlPropagateAdditionalData - true or false. Default is false.
UnapproveTransactionsWhenClickAndConversionIPDontMatch - true or false. (CPA/CPL Campaigns ONLY). Default is false.
UnapproveTransactionsClickToConversionLessThanValue - Must be a whole number. Example: 1,2,3 ,(CPA/CPL Campaigns ONLY). Default is false.
UnapproveTransactionsClickToConversionLessThanTimeFrame - Minutes / Seconds. (CPA/CPL Campaigns ONLY)
UnapproveTransactionsWhenIPFromPublicProxy - true or false. (CPA/CPL Campaigns ONLY)
DoNotTrackTransactionsWithDuplicateMerchantReferenceIDsWithinTheLast90Days - true or false. (CPA/CPL Campaigns ONLY). Default is false.
UnapproveTransactionsWhenTheConfirmationPageDomainDoesMotMatchUrl - true or false. (CPA/CPL Campaigns ONLY). Default is false and the confirmation page domain is required if set to true. Example:
*Must be encoded*
<ApprovedConfirmationPageUrls>
<string>http://ComfUrl1?id=123&pid=12</string>
<string>http://ComfUrl2?id=123&pid=12</string>
</ApprovedConfirmationPageUrls>
ArePromoCodesFiltered - true or false. Default is false.
ArePromoCodesBlackList - true or false. Default is true.
DoNotTrackFilteredPromoCodes - true or false. Default is false.
PromoCodes - Alphanumeric string of values and required if 'ArePromoCodesFiltered' is set to true. Example:
<string>Promo1</string>
<string>Promo2</string>
Notes
InsertionOrder - true or false. Default is set to false.
PrePayment - decimal values - 85, 85.21. Default is blank.
Notes - Alphanumeric values. Unlimited characters. Default is blank.
Affiliate Center Settings
Title - Alphanumeric values only. Defaults to the campaign name if not specified. 255 character max.
Description - Alphanumeric values or HTML, unlimited characters. Default is blank. *NOTE- if you use HTML, it must be included as CDATA.
Example: <![CDATA[
Your HTML description here.
]]>
SpecialInstructions - Alphanumeric values or HTML, unlimited characters. Default is blank. *NOTE- if you use HTML, it must be included as CDATA.
Example: <![CDATA[
Your HTML description here.
]]>
ImpressionUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54, defaults to the default campaign settings if not specified, required if the format is 'Custom'. Max 3000 characters.
ImpressionUrlFormat - Standard/SEO/Custom. Defaults to default campaign settings if not specified. Required if the format is 'Custom'. Max 3000 characters.
TrackingUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54, defaults to the default campaign settings if not specified. Required if the format is 'Custom'.
TrackingUrlFormat - Standard/SEO/Custom. Defaults to the default campaign settings if not specified
AutoAssignOnApprovedAffiliateApplication - true or false. Defaults to the default campaign settings if not specified
AutoAssignOnAffiliateCenterRequest - true or false, defaults to default campaign settings if not specified
TrafficTypeIds - list of integers. Download a list of available Traffic Types and their ID's here. Example:
<int>1</int>
<int>2</int>
NetworkExclusivity - Exclusive/NonExclusive/AgencyOfRecord. Default is N/A.
HasRecurringCommission - true or false. Default is false. (CPA/CPL Campaigns Only)
SeasonalNames - Must be a string of valid seasonal name(s) from your account. Example: All, Spring, Summer, Fall, (<string>Spring</string>, <string>Summer</string>), Default is all seasons allowed.
Values allowed: (Old, Female, Male, Sports, Outdoors, Graduation, Death, Birth, Birthday, Anniversary, Wedding, Taxes, BacktoSchool, SpringBreak, Hanukah, Young, Christmas, Thanksgiving, Halloween, VeteransDay, Easter, CincodeMayo, FourthofJuly, MemorialDay, StPatricksDay, ValentinesDay, PresidentsDay, NewYears, Winter, Summer, Spring, Fall)
VisibilityGroups - Must be a string of group names from your account. Default is visible by all groups. Example: (<string>Silver</string>, <string>emailgroup</string>, <string>Standard</string>)
TermsAndConditions - Alphanumeric values. Default is blank.
EmailFromLines - Alphanumeric list of values. Default is blank. Example:
<EmailFromLines>
<string>From line 1</string>
<string>From line 2</string>
</EmailFromLines>
EmailSubjectLines - Alphanumeric list of values. Default is blank. Example:
<EmailSubjectLines>
<string>Subject line 1</string>
<string>Subject line 2</string>
</EmailSubjectLines>
SuppressionFileUrl - Must be a valid URL and encoded. Example: http://linktrust.com?id=1234&pid=54. Default is blank.
Pixel (CPA/CPL Campaigns Only)
AllowAffiliateToManageTheirPixel - true or false. Defaults to the default campaign settings
PixelType - JavaScript, Image, ServerSide. Default is JavaScript
AllowAffiliateToPlaceImagePixel - true or false. Defaults to the default campaign settings
AllowAffiliatesToPlaceJavaScriptPixels - true or false. Defaults to the default campaign settings
AllowAffiliateToPlaceServerSidePixels - true or false. Defaults to the default campaign settings
AllowAffiliateToPlaceIFramePixels - true or false. Defaults to the default campaign settings
AllowAffiliatesToAddAdditionalCode - true or false. Defaults to the default campaign settings. Only set to true if the pixel type is JavaScript.
RequireSecurePixelURLs - true or false. Defaults to the default campaign settings
OptionalAdditionalCodeForCampaign - optional. Defaults to the default campaign settings. Only displayed if pixel type is JavaScript. HTML MUST BE ENCODED
Rights
ViewImpressionInAffiliateCenter - true or false. Defaults to the default campaign settings
ViewClicksInAffiliateCenter - true or false. Defaults to the default campaign settings
ViewQualifiedInAffiliateCenter - true or false. Defaults to the default campaign settings
ExportQualifiedTransactionsInAffiliateCenter - true or false. Defaults to the default campaign settings
HideQualifiedConversionIPandReferrerAffiliateCenter - true or false. Defaults to the default campaign settings
ExportApprovedTransactionsInAffiliateCenter - true or false. Defaults to the default campaign settings
HideApprovedConversionIPandReferrerAffiliateCenter - true or false. Defaults to the default campaign settings
ViewImpressionInMerchantCenter - true or false. Defaults to the default campaign settings
ViewClicksInMerchantCenter - true or false. Defaults to the default campaign settings
ViewQualifiedInMerchantCenter - true or false. Defaults to the default campaign settings
Example XML
Download an example of this XML here.
JSON Format
These are the minimum and required fields to create a campaign.
Required Values (*)
*Type - 1 or "CPA" / 2 or "CPL" / 4 or "CPC" - Required and must be all caps
*CampaignName - Required and must be more than 1 character and less than 255 characters, (<, >, /, |, ~ not allowed)
*Category - Required and must be exact match to an existing category Example: Computers & Electronics, <, >, /, |, ~ not allowed
*MerchantId - Required and must be a valid merchant id from your account
*DefaultLandingPageURL - Required and must be a valid url, http://..., 2000 character max.
Sample
{
"Campaign":
{
"CampaignName":"test",
"Type":"CPA",
"Category":"Teen/College",
"MerchantId":100004,
"DefaultLandingPageURL":"http://google.com",
}
}
Optional Values - Remove completely if not included in your API call
CampaignStatus - (1 or "Testing" / 2 or "PublicLive" / 3 or "Paused" / 4 or "Dead" / 5 or "PrivateLive") NOT case sensitive, defaults to Testing
DefaultLandingPageAllowUnassignedTraffic - true or false, default is false
DefaultLandingPagePropagateAdditionalData - true or false, default is false
DefaultLandingPageHideAffiliateReferrers - true or false, default is false
Group - Optional and must be an exact match to an existing group, defaults to the default campaign settings.
Revenue - decimal values up to 4 decimals allowed, default is 0, example: 1.00, 1, 10, 10.55, 10.5456
RevenueType - Flat/flat or Percent/percent, default is Flat. Example: 0 or "Flat" / "flat", 1 or "Percent" / "percent"
DefaultAffiliatePayout - decimal values up to 4 decimals allowed, Default is 0, example: 1.00, 1, 10, 10.55, 10.5456
DefaultAffiliatePayoutType - Flat or Percent, default is Flat, MUST be Flat if Merchant Revenue is Flat or not provided since the Revenue default is Flat. Example: "Flat"/"flat", "Percent"/"percent"
AutoApproveTransactionForAllAffiliates - true or false, defaults to the default campaign settings.
CampaignManagers - Must be a valid user id and included in [10037,10046] tags, default is no manager
Affiliates - Must be a valid affiliate id and included in [100000,100001,100003] tags, default is no affiiates
StartDate - Format: yyyy-MM-dd, 2012-10-15, must be before the expiration date, default is blank
ExpirationDate - Format: yyyy -MM-dd, 2015-10-15, must be after the start date, default is blank
ExpiredRedirectType - 2 or URL / 1 or Campaign / 0 = Forbidden, defaults to the default campaign settings.
RedirectCampaignId - Example: 100166, must be a valid campaign ID from your account, defaults to the default campaign settings.
PropogateCookieParameter - true or false, defaults to the default campaign settings.
PropogateTrackingParameter - true or false, defaults to the default campaign settings.
PropogateAdditionalData - true or false, defaults to the default campaign settings.
ExpiredRedirectUrl - Required if redirect type is set to URL. Example: http://www.gmail.com, must be a valid Url, defaults to the default campaign settings.
ExpiredRedirectUrlPropagateAdditionalData - true or false, default is false
CookieLife - Must be a whole number. Example: 1,2,3... Defaults to the default campaign settings. (CPA/CPL Campaigns ONLY)
Tracking - Standard/Mobile, default is Standard. (CPA/CPL Campaigns ONLY). Example:"Mobile"/"Standard"
AllowClickIDPostbacks - true or false, default is true. (CPA/CPL Campaigns ONLY)
AllowAFIDPostbacks - true or false, default is false. (CPA/CPL Campaigns ONLY)
EnablePayPerCallIntegration - true or false, default is false. (CPA/CPL Campaigns ONLY)
AllowCookieTracking - true or false, default is true. (CPA/CPL Campaigns ONLY)
AllowCookielessTracking - true or false, default is true. (CPA/CPL Campaigns ONLY)
RestrictPostbackToWhitelistedIPs - true or false, default is false. (CPA/CPL Campaigns ONLY)
AllowCustomConversionParameters - true or false, default is false. (CPA/CPL Campaigns ONLY)
AllowExternalTransactionModifications - true or false, default is false. (CPA/CPL Campaigns ONLY)
ExternalTransactionModificationPassword - Alphanumeric values, Required if 'Allow External Transaction Modifications' is true. , default is blank. Max 50 characters.(CPA/CPL Campaigns ONLY)
OnlyAllowModificationsFromWhitelistedIPs - true or false, Required if 'Allow External Transaction Modifications' is true, default is false. (CPA/CPL Campaigns ONLY)
EnableProductDataFeed - true or false, default is false. (CPA/CPL Campaigns ONLY)
Filters
RecordOnlyUniqueImpression - true or false, defaults to the default campaign settings.
UniqueImpressionValidValue - Must be a whole number, ie...1,2,3,4,5. Defaults to the default campaign settings.
UniqueImpressionTimeFrame - 1 or "Minutes" / 2 or "Hours" / 3 or "Days", defaults to the default campaign settings.
IfNoReferrerSetAsDuplicateClick - true or false, defaults to the default campaign settings.
AllowDuplicateClicksByIp - true or false, defaults to the default campaign settings.
TrackUniqueClicks - true or false, defaults to the default campaign settings.
DuplicateClickValidValue - must be a whole number, defaults to the default campaign settings.
DuplicateClickValidTimeFrame - 1 or "Minutes" / 2 or "Hours" / 3 or "Days", defaults to the default campaign settings.
DuplicateIpRedirectType - 0 or "Forbidden" / 1 or "Campaign" / 2 or "URL" / 3 or "LandingPage", defaults to the default campaign settings.
Duplicate Redirect Campaign
RedirectCampaignId - Must be a valid campaign ID from your account: Example - 123456, defaults to the default campaign settings. Required if redirect type is Campaign.
PropogateCookieParameter - true or false, defaults to the default campaign settings.
PropogateTrackingParameter - true or false, defaults to the default campaign settings.
PropogateAdditionalData - true or false, defaults to the default campaign settings.
DuplicateIpRedirectUrl - Must be a valid url, Example: http://www.google.com, defaults to the default campaign settings.
DuplicateIpRedirectUrlPropagateAdditionalData - true or false, defaults to the default campaign settings.
DuplicateIpRedirectLandingPageWriteCookie - true or false, defaults to the default campaign settings. (CPA/CPL Campaigns ONLY)
BlockedAffiliateRedirectType - 4 or "Forbidden" / 1 or "Campaign" / 2 or "URL", defaults to the default campaign settings.
BlockedAffiliateRedirectCampaign (ONLY INCLUDE THE CODE FOR THE TYPE SUBMITTED. FOR EXAMPLE, IF THE TYPE IS URL, REMOVE CODE FOR FORBIDDEN AND CAMPAIGN)
RedirectCampaignId - Must be a valid campaign ID from your account, Example: 123456, defaults to the default campaign settings.
PropogateCookieParameter - true or false, defaults to the default campaign settings.
PropogateTrackingParameter - true or false, defaults to the default campaign settings.
PropogateAdditionalData - true or false, defaults to the default campaign settings.
BlockedAffiliateRedirectUrl - Required if the redirect type is set to URL. Must be a valid URL, Example: http://www.gmail.com, defaults to the default campaign settings.
BlockedAffiliateRedirectUrlPropagateAdditionalData - true or false, defaults to the default campaign settings.
BlockClicksFromPublicProxies - true or false, defaults to the default campaign settings.
TrafficCapRedirectType - 0 or "Forbidden" / 1 or "Campaign" / 2 or "URL", defaults to the default campaign settings.
Traffic Cap Redirect Campaign
RedirectCampaignId - Must be a valid campaign ID from your account. Example: 123456, defaults to the default campaign settings.
PropogateCookieParameter - true or false, defaults to the default campaign settings.
PropogateTrackingParameter - true or false, defaults to the default campaign settings.
PropogateAdditionalData - true or false, defaults to the default campaign settings.
TrafficCapRedirectUrl - Must be a valid URL, Example: http://linktrust.com, defaults to the default campaign settings.
TrafficCapRedirectUrlPropagateAdditionalData - true or false, defaults to the default campaign settings.
Countries - Defaults to ALL countries. Example: "Countries":["Uganda", "Brazil", "Germany"],
UnauthorizedCountryRedirectType - 0 or "Forbidden" / 1 or "Campaign" / 2 or "URL" / 3 or "LandingPage", Required if countries are specified.
Unauthorized Country Redirect Campaign
RedirectCampaignId - Required if type is Campaign. Must be a valid campaign ID from your account. Example: 123456.
PropogateCookieParameter - true or false, defaults to false.
PropogateTrackingParameter - true or false, defaults to false.
PropogateAdditionalData - true or false, defaults to false.
UnauthorizedCountryRedirectUrl - Required if type is URL. Must be a valid URL. Example: http://www.amazon.com
UnauthorizedCountryRedirectUrlPropagateAdditionalData - true or false, default is false.
UnauthorizedCountryRedirectLandingPageWriteCookie - true or false, default is false.
SpecificCountryRedirects - Specific country you wish to redirect traffic for.
CountryName - Example: "CountryName":"Afghanistan",
RedirectType - 1 or "Campaign" / 2 or "URL", Example: "RedirectType":2,
Redirect Campaign
RedirectCampaignId - Must be a valid campaign from your account. Example: 123456
PropogateCookieParameter - true or false, default is false
PropogateTrackingParameter - true or false, default is false
PropogateAdditionalData - true or false, default is false
RedirectUrl - Must be a valid URL. Example: http://www.aol.com
RedirectUrlPropagateAdditionalData - true or false, default is false
UnapproveTransactionsWhenClickAndConversionIPDontMatch - true or false,(CPA/CPL Campaigns ONLY), default is false
UnapproveTransactionsClickToConversionLessThanValue - Must be a whole number. Example: 1,2,3 ,(CPA/CPL Campaigns ONLY), default is false
UnapproveTransactionsClickToConversionLessThanTimeFrame - 1 or "Minutes" / "Seconds", (CPA/CPL Campaigns ONLY)
UnapproveTransactionsWhenIPFromPublicProxy - true or false,(CPA/CPL Campaigns ONLY)
DoNotTrackTransactionsWithDuplicateMerchantReferenceIDsWithinTheLast90Days - true or false,(CPA/CPL Campaigns ONLY), default is false
UnapproveTransactionsWhenTheConfirmationPageDomainDoesMotMatchUrl - true or false,(CPA/CPL Campaigns ONLY), default is false, confirmation page domain is required if set to true. Example: ["http://ComfUrl1","http://ComfUrl2"]
ArePromoCodesFiltered - true or false, default is false
ArePromoCodesBlackList - true or false, default is true
DoNotTrackFilteredPromoCodes - true or false, default is false
PromoCodes - Alphanumeric string of values and required if 'ArePromoCodesFiltered' is set to true. Examples: ["Promo1","Promo2"]
Notes
InsertionOrder - true or false, default is set to false.
PrePayment - decimal values - 85, 85.21, default is blank
Notes - Alphanumeric values, Unlimited characters, default is blank
Affiliate Center Settings
Title - Alphanumeric values only, defaults to the campaign name if not specified. 255 character max.
LogoImageUrl – (place image logo URL here)
Description - Alphanumeric values, unlimited characters, default is blank
SpecialInstructions - Alphanumeric values, unlimited characters, default is blank
ImpressionUrl - Must be a valid URL. Example: http://impressionurl.com, defaults to default campaign settings if not specified, required if the format is 'Custom'
ImpressionUrlFormat - 0 or "Standard" / 1 or "SEO" / 2 or "Custom", defaults to default campaign settings if not specified, Required if the format is Custom.
TrackingUrl - Must be a valid URL. http://trackingurl.com, defaults to default campaign settings if not specified, Required if the format is 'Custom'.
TrackingUrlFormat - 0 or "Standard" / 1 or "SEO" / 2 or “Custom”, defaults to default campaign settings if not specified
AutoAssignOnApprovedAffiliateApplication - true or false, defaults to default campaign settings if not specified
AutoAssignOnAffiliateCenterRequest - true or false, defaults to default campaign settings if not specified
TrafficTypeIds - list of integers. Download a list of available Traffic Types and their ID's here. Example: [1,2,3,4]
NetworkExclusivity - 1 or "NA" / 2 or "Exclusive" / 3 or "NonExclusive" / 4 or "AgencyOfRecord", default is N/A
HasRecurringCommission - true or false, default is false (CPA/CPL Campaigns Only)
SeasonalNames - Must be a string of valid seasonal name(s) from your account. Example: All, Spring, Summer, Fall, Example: ["Spring","fall"], Default is all seasons allowed.
Values allowed: (Old, Female, Male, Sports, Outdoors, Graduation, Death, Birth, Birthday, Anniversary, Wedding, Taxes, BacktoSchool, SpringBreak, Hanukah, Young, Christmas, Thanksgiving, Halloween, VeteransDay, Easter, CincodeMayo, FourthofJuly, MemorialDay, StPatricksDay, ValentinesDay, PresidentsDay, NewYears, Winter, Summer, Spring, Fall)
VisibilityGroups - Must be a string of group names from your account, default is visible by all groups. Example: ["Email Group","Silver"]
TermsAndConditions - Alphanumeric values, default is blank
EmailFromLines - Alphanumeric list of values, default is blank. Example: ["From lines", "more from lines"]
EmailSubjectLines - Alphanumeric list of values, default is blank. Example: ["Subject lines", "more Subject lines"]
SuppressionFileUrl - Mut be a valid URL. Example: http://linktrust.net. Default is blank.
Pixel (CPA/CPL Campaigns Only)
AllowAffiliateToManageTheirPixel - true or false, defaults to the default campaign settings
PixelType - 1 or "Image", 2 or "JavaScript", 3 or "ServerSide", default is JavaScript
AllowAffiliateToPlaceImagePixel - true or false, defaults to the default campaign settings
AllowAffiliatesToPlaceJavaScriptPixels - true or false, defaults to the default campaign settings
AllowAffiliateToPlaceServerSidePixels - true or false, defaults to the default campaign settings
AllowAffiliateToPlaceIFramePixels - true or false, defaults to the default campaign settings
AllowAffiliatesToAddAdditionalCode - true or false, defaults to the default campaign settings. Only set to true if the pixel type is JavaScript.
RequireSecurePixelURLs - true or false, defaults to the default campaign settings
OptionalAdditionalCodeForCampaign - optional code, defaults to the default campaign settings. Only displayed if pixel type is JavaScript. HTML MUST BE ENCODED
Rights
ViewImpressionInAffiliateCenter - true or false, defaults to the default campaign settings
ViewClicksInAffiliateCenter - true or false, defaults to the default campaign settings
ViewQualifiedInAffiliateCenter - true or false, defaults to the default campaign settings
ExportQualifiedTransactionsInAffiliateCenter - true or false, defaults to the default campaign settings
HideQualifiedConversionIPandReferrerAffiliateCenter - true or false, defaults to the default campaign settings
ExportApprovedTransactionsInAffiliateCenter - true or false, defaults to the default campaign settings
HideApprovedConversionIPandReferrerAffiliateCenter - true or false, defaults to the default campaign settings
ViewImpressionInMerchantCenter - true or false, defaults to the default campaign settings
ViewClicksInMerchantCenter - true or false, defaults to the default campaign settings
ViewQualifiedInMerchantCenter - true or false, defaults to the default campaign settings
Example JSON
Download an example of this JSON here.
You can request a demo to see LinkTrust up close and experience how it can help you, or start your free 14-day trial now.
Need help with this feature or have questions? You can contact our support team at support@linktrust.com