Offeritnick: /* PATCH /creative/_creative_rule */

2022-08-26T16:37:23Z

‎PATCH /creative/_creative_rule

Offeritnick at 21:25, 12 May 2017

2017-05-12T21:25:30Z

OfferitRob at 20:48, 22 March 2017

2017-03-22T20:48:32Z

OfferitRob: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /creative/_creative_rule''' == '''Description''' *edit_creative_rule expires an existing creative rule and cr..."

2017-03-22T19:55:47Z

Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /creative/_creative_rule''' == '''Description''' *edit_creative_rule expires an existing creative rule and cr..."

New page

{{Offerit Manual
| show_api_admin_section = true
}}

== '''PATCH /creative/_creative_rule''' ==
'''Description'''
*edit_creative_rule expires an existing creative rule and creates a new one.

'''Resource URL'''
*<nowiki>http://domain/api/creative/edit_creative_rule</nowiki>
*Replace domain with the Offerit domain

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH

'''[[Offerit_REST_API_Overview#Authentication|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'''

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

*Response:
<pre>
{
"successes":
{"13":
{
"creativeid": "13",
"original_ruleid": "57c737f693a89",
"new_ruleid": "57c9b48dee963"
}
},
"failures": [],
"total_successes": 1
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?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);
?>
</pre>

[[Category:Offerit API Articles]]

@@ Line 3: / Line 3: @@
 }}
-== '''PATCH /creative/_creative_rule''' ==
+== '''PATCH /creative/edit_creative_rule''' ==
 '''Description'''
 *edit_creative_rule expires an existing creative rule and creates a new one.

@@ Line 105: / Line 105: @@
 );
 $resp = curl_exec($curl);
-//dumps an associative array representation of the json
+//dumps an associative array representation of the json response
-var_dump(json_decode($resp, true));
+$output = json_decode($resp, true);
 // Close request to clear up some resources
 curl_close($curl);

@@ Line 1: / Line 1: @@
 {{Offerit Manual
-| show_api_admin_section = true
+| show_rest_api_section = true
 }}

Offerit REST API Edit Creative Rules - Revision history

Offeritnick: /* PATCH /creative/_creative_rule */

Offeritnick at 21:25, 12 May 2017

OfferitRob at 20:48, 22 March 2017

OfferitRob: Created page with "{{Offerit Manual | show_api_admin_section = true }} == '''PATCH /creative/_creative_rule''' == '''Description''' *edit_creative_rule expires an existing creative rule and cr..."