Versions Compared

Version Old Version 6 New Version Current
Changes made by

Danny Hannah

Rokas B

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Active White Papers API will return all white papers that are available for specified locale and website.

Authentication

Once you've requested an access token, you'll be able to start making calls to the API.

Be aware that if your password is expired you will still receive an access token, but will receive the
Note
Info

Please note that in order for white papers to appear in the response, they need to follow the existing logic and meet the following criteria:

  • Be assigned to a content block

  • Be assigned to an active campaign

    • Campaign must have not ended or Unavailable campaign logic must be: Allow leads to campaign

  • Be assigned to a subcategory

  • Have an active “Publisher” on the associated campaign

  • Have a ‘Website Enabled’ tracking link

Authentication

Once you've requested an access token, you'll be able to start making calls to the API.

Note

Beware that if your password is expired you will still receive an access token, but will receive the following error on any other API requests.

You can see the status password_expired property which is returned along with your access token - if it’s true then you will need to reset your password.

...

Active Campaign White Papers API

...

Please note that in order for white papers to appear in the response, they need to follow the existing logic and meet the following criteria:

...

Be assigned to an active campaign

  • Campaign must have not ended

  • Campaign must have available allocation or be uncapped

...

Have an active “Publisher” on the associated campaign

...

Request

Code Block
https://{enterprise}.cvtr.io/api/v4/campaign-whitepapers/active/{WEBSITE_ID}/{LOCALE_ID}?access_token={ACCESS_TOKEN}

...