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

View
 

Tools: Text Links API Methods


txtlinks/list

List Text Links in a Campaign.

 

  GET /campaigns/#{campaign_id}/txtlinks.{json or xml} 

 

// Code

txtlinks_list($campaign_id, $page=1, $perpage=6)

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

txtlinks/show

Show details about a Text Link.

 

  GET /campaigns/#{campaign_id}/txtlinks/#{txtlink_id}.{json or xml} 

 

// Code

txtlink_show($campaign_id, $txtlink_id) 

 

Parameters:

  • campaign_id.  Required. A Campaign ID.
  • txtlink_id.  Required. A Text Link ID.

txtlinks/search

Search for Text Links.

 

  GET /campaigns/#{campaign_id}/txtlinks/search.{json or xml} 

 

// Code

txtlinks_search($campaign_id, $search, $page=1, $perpage=6, $sort='date')

 

Parameters:

  • campaign_id.  Required. A Campaign ID or 'approved' for searching in campaigns that has the affiliate approved.
  • search. Required. Keywords. Use advanced searching syntax to search through all the fields of each text link.
    • available fields to search by: id, title, help, url, category, unique_code.

 

  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.
  • perpage. the number of links to be displayed on a page
  • sort. Optional. Sort (by date, clicks, actions, abc [this is alphabetical], update_type [manual added products, from widget and imported], random)

txtlinks/create

Advertisers: Create a new Text Link.

 

  POST /campaigns/{$campaign_id}/txtlinks.{json or xml} 

 

// Code
txtlink_create($campaign_id, $txtlink) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtlink. Required. An Array  that contains ("title" => "title", "url" => "url", "help" => "help") or XML/JSON equivalent.

txtlinks/update

Advertisers: Update a Text Link.
 
  PUT /campaigns/{$campaign_id}/txtlinks/#{txtlink_id}.{json or xml} 

 

// Code

txtlink_update($campaign_id, $txtlink_id, $txtlink) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtlink_id. Required. A Text Link ID.
  • txtlink. Required. The modified Text Link.

txtlinks/destroy

Advertisers: Delete a Text Link.

 

  DELETE /campaigns/{$campaign_id}/txtlinks/#{txtlink_id}.{json or xml} 

 

// Code

txtlink_destroy($campaign_id, $txtlink_id) 

 

Parameters:

  • campaign_id. Required. A Campaign ID.
  • txtlink_id.  Required. A Text Link ID.