Difference between revisions of "Offerit REST API Edit Creative Rules"

Revision as of 15:48, 22 March 2017

PATCH /creative/_creative_rule

Description

• edit_creative_rule expires an existing creative rule and creates a new one.

Resource URL

• http://domain/api/creative/edit_creative_rule
• Replace domain with the Offerit domain

Response Format

• JSON

Request Method

• PATCH

Authentication

• HTTP headers

Parameters

• creativeids
  • type: integer,string,array
  • required
  • either creativeids for which you are editing rules. accepts int, comma separated list of ints, array of ints.
• ruleid
  • type: string
  • required
  • the ruleid that you are editing.
• rule_type
  • type: string
  • required
  • SHOW, HIDE, or IGNORE

• offerids
  • type: integer,string,array
  • required
  • offer ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
• landing_pageids
  • type: integer,string,array
  • required
  • landing page ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
• loginids
  • type: integer,string,array
  • required
  • affiliate login ids that this rule applies to. accepts int, comma separated list of ints, array of ints.
• start_time
  • type: string
  • optional
  • we will run stringtotime on this. Default Now
• end_time
  • type: string
  • optional
  • we will run stringtotime on this. Default Never

Example Request

PATCH

http://domain/api/creative/edit_creative_rule?creativeids=1&ruleid=57c737f693a89&offerids=1&rule_type=HIDE

• Response:

{
   "successes": 
   {"13":    
   	{
      "creativeid": "13",
      "original_ruleid": "57c737f693a89",
      "new_ruleid": "57c9b48dee963"
   	}
   },
   "failures": [],
   "total_successes": 1
}

Example Code

PHP

<?php 
$url = 'http://domain/api/creative/edit_creative_rule'
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
); 
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url); 

$data = Array(
	'creativeids' => 1,
	'ruleid' => '57c737f693a89',
	'start_time' => 'January 1, 2016',
	'offerids' => '1,2,3',
	'rule_type' => 'SHOW',
);                                                   
$resp = curl_exec($curl); 
//dumps an associative array representation of the json 
var_dump(json_decode($resp, true)); 
// Close request to clear up some resources 
curl_close($curl); 
?>