Versions Compared

Key

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

...

Code Block
languagejs
titleGET request - Campaign Form Fields
https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/form/fields?apikey=([campaignAPIkey)]

Example Form Fields Response

...

Code Block
languagejs
titleGET request - Campaign Links
https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/links?apikey=[campaignAPIkey]

Example Campaign Links Response

...

The API campaign key method will allow you to post leads to the given campaign.

Example Lead Post Request

Code Block
languagejs
titlePOST request - Lead Data
https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/links?apikey=[campaignAPIkey]&campaignLinkId=[linkid]

Example Lead Post Request

Additionally if you want to pass the publisher id with the lead you can post as below (the publisher ID can be obtained from the platform by going to the publisher section https://[enterprise].cvtr.io/publisher/list).

Code Block
languagejs
titlePOST request - Lead Data
https://[enterprise].cvtr.io/webhook/campaign/[CampaignID]/links?apikey=[campaignAPIkey]&campaignLinkId=[linkid]&publisherId=[publisherId]

Example Lead Post Payload (unencoded)

...

Code Block
titleGET response - Form Fields
{
    "code": 201,
    "message": "Lead was created successfully",
    "data": 55907
}

Error Responses