Upcoming API changes

Campaign Templates

https://{enterprise}.cvtr.io/api/v4/campaigns

GET:

The REST client with admin and agency roles can use GET requests to retrieve campaign details and will now see a new boolean flag, 'isTemplate' . Campaigns identified as templates will have 'isTemplate' set to true. The default value of 'isTemplate' is false so that all existing campaigns will return 'isTemplate' as false unless changed.

https://{enterprise}.cvtr.io/api/v4/campaigns/{campaignId}

{ 
     ... 
     'unavailableCampaignLogic' => 'allow_leads',
     'unavailableCampaignRedirectUrl' => '', 
     'uncapped' => false, 
     ... 
     'isTemplate' => true, 
     ... 
}

POST:

The REST client with admin roles can use a POST request to create a new campaign and designate the campaign as a template, the 'isTemplate' field should be set to true.

{ 
     ... 
     'unavailableCampaignLogic' => 'allow_leads', 
     'unavailableCampaignRedirectUrl' => '', 
     'uncapped' => false, 
     ... 
     'isTemplate' => true, 
     ... 
}

While creating a new campaign, if the 'isTemplate' is not set as true, the campaign will be identified as normal campaign.

PUT:

The REST client with admin roles can use PUT request to update a campaign, and designate the campaign as a template by setting the 'isTemplate' field set to true.

https://{enterprise}.cvtr.io/api/v4/campaigns/{campaignId}

{
     ... 
     'isTemplate' => true, 
     ... 
}

Publisher Notifications

We are introducing publisher notifications that allow campaign managers to share campaign changes with publishers more efficiently.

To support this, we are adding hasUncommunicatedChangesSinceTs data to GET /api/v4/campaigns endpoint response.

https://{enterprise}.cvtr.io/api/v4/campaigns

GET:

https://{enterprise}.cvtr.io/api/v4/campaigns/{campaignId}

{ 
     ... 
     'hasUncommunicatedChangesSinceTs' => '2024-06-05T11:00:30+01:00', 
     ... 
}