Activation

The various methods for Activation are listed below:

Activate retail campaign

Triggers activation of a retail campaign — generates trackers and/or creative assets and pushes the campaign live. Requires MediaPlan_Tags_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com//v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/activate
Copy

Parameters

Field	Data Type	Requirement	Description
trackerTypes	array of string	Optional	List of tracker types to generate. Values: `GCM`.
assetGenerationType	enum (string)	Optional	Asset format to generate. Values: `png`, `gif`, `video`, `tiff`.

Request Body

JSON
    
 
{  "trackerTypes": ["GCM"],  "assetGenerationType": "png"}
Copy

Response

Field	Data Type	Description
message	string	Result message from the activation flow.
retailCampaignIdx	integer	Index of the activated retail campaign.

Request Body

JSON
    
 
{  "message": "Campaign activated successfully",  "retailCampaignIdx": 5373}
Copy

Get activation status

Returns the current activation status and progress percentage for a retail campaign. Requires MediaPlan_Tags_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retailcampaigns/:retailCampaignIdx/activationstatus
Copy

Response

Field	Data Type	Description
percentage	integer	Activation progress as a percentage (0–100).
message	string	Human-readable status message.
status	enum (string)	Current activation status. Values: `NEW`, `DRAFT`, `IN_PROGRESS`, `FAILED`, `ACTIVE`, `PUBLISHED` (pushed to DSP, awaiting activation), `ENDED`, `EXAMINE`.

Request Body

JSON
    
 
{  "percentage": 75,  "message": "Generating creative assets...",  "status": "IN_PROGRESS"}
Copy

Last updated on

Was this page helpful?