POST api/Partner/ActivateCampaign
Handle the state of the campaign. Any updates on title text or image url's from banner previews are saved permanently by calling GetPixelScript() with the corresponding feAdId.
Request Information
URI Parameters
None.
Body Parameters
Activation options
FrantzActivateCampaignRequestName | Description | Type | Additional information |
---|---|---|---|
apiToken |
API Token provided using the Auth method |
string |
Required |
PartnerId |
API Token provided using the Auth method |
globally unique identifier |
None. |
activationOption |
Required activation state |
ActivationState |
Required |
bannerSizeFormat |
Banner ad size to save for use on the campaign |
BannerSizeFormat |
None. |
channel |
Select the channel in which you want to activate the campaign |
AdNetworkType |
None. |
campaignStart |
Set start date for the campaign ad |
date |
None. |
campaignEnd |
Set end date for the campaign ad |
date |
None. |
feAdId |
The campaign to handle |
integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443", "PartnerId": "00000000-0000-0000-0000-000000000000", "activationOption": 1, "bannerSizeFormat": 12, "channel": 1, "campaignStart": "2025-04-23T08:29:58.6932527+02:00", "campaignEnd": "2025-05-07T08:29:58.6932527+02:00", "feAdId": 487811 }
Response Information
Resource Description
JsonResultOfFrantzActivateCampaignResponseName | Description | Type | Additional information |
---|---|---|---|
Content | FrantzActivateCampaignResponse |
None. |
|
SerializerSettings | JsonSerializerSettings |
None. |
|
Encoding | Encoding |
None. |
|
Request | HttpRequestMessage |
None. |
Response Formats
application/json, text/json
Sample:
{ "ReportUrl": "https://login.frantz.no/Dashboard/CampaignReport?code=12c26cba-6265-4518-8460-1bc0a8309454", "TokenExpiracy": "2025-05-23T00:00:00+02:00", "ScheduledStartTime": "0001-01-01T00:00:00", "AvailableReportData": "0001-01-02T07:00:00", "StatusCode": 200, "StatusMessage": "Success" }