API Reference

Retrieve or download public terms

Parameters

No parameters.

Returns

Returns the public terms object if a valid CampaignId is provided and public terms exist for the specified campaign.

You can also append /Download as a path parameter to download the pdf version of the public terms. Be sure to pass the header Accept: application/pdf when downloading a pdf file using this API call.

Example Request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Campaigns/<CampaignId>/PublicTerms' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Campaigns/<CampaignId>/PublicTerms/Download' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/pdf' \
  -o 'PublicTerms.pdf'

Example Response

{
  "Id": "12345",
  "Name": "Public Terms",
  "CampaignId": "1234",
  "CampaignName": "ACME Inc.",
  "PayoutTermsList": [
    {
      "TrackerName": "Sale",
      "TrackerType": "SALE",
      "PayoutPercentage": "",
      "PayoutAmount": "10.00",
      "PayoutCurrency": "USD",
      "ReferralPeriod": "30",
      "ReferralPeriodUnit": "DAY",
      "PayoutAmountLowerLimit": "10.00",
      "PayoutAmountUpperLimit": "10.00",
      "PayoutPercentageLowerLimit": "",
      "PayoutPercentageUpperLimit": ""
      }
    ],
  "PdfUri": "/Mediapartners/<AccountSID>/Campaigns/1234/PublicTerms/Download",
  "Uri": "/Mediapartners/<AccountSID>/Campaigns/1234/PublicTerms"
}