• 30 Minute Maintenance Window, Midnight Pacific, Sat May 19. Learn more.

View
 

Admin Campaigns API Methods


campaigns/list

Lists Campaigns.

 

  GET /campaigns.{json or xml} 

 

// Code

admin_campaigns_list($page=1, $perpage=15) 

 

Parameters:

  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

campaigns/search

Search through Campaigns.

 

  POST /campaigns/search.{json or xml} 

 

// Code

admin_campaigns_search($search=null, $page=1, $perpage=15)

 

Parameters:

  • search. Optional. Keywords to search for.  
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

campaign/update

Update a Campaign.

 

  PUT /campaigns/#{campaign_id}.{json or xml} 

 

// Code

admin_campaign_update($campaign_id, $suspend=null, $reset=null)

 

Parameters:

  • campaign_id. Required.A Campaign ID. 
  • suspend. Optional. 0 (the campaign is/will be active) or 1 (the campaign is/will be suspended), 
  • reset. Optional. When activating a campaign if we should delete all clicks, actions and commissions from it.

campaign/destroy

Destroy a Campaign

 

  DELETE /campaigns/#{campaign_id}.{json or xml} 

 

// Code

admin_campaigns_destroy($campaign_id) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.