View source for Offerit REST API Edit Creative

{{Offerit Manual
| show_api_admin_section = true
}}

== '''PATCH /creative/edit_creative''' ==
'''Description''' 
*Use this API end point to edit an existing creative. 

'''Resource URL'''
*<nowiki>http://domain/api/creative/edit_creative</nowiki>
*Replace domain with your 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''' ==
*creative_id
**'''''type: integer'''''
**'''''required'''
**'''''this is the unique id of the creative to be re-enabled
*creative_data
**'''''type: json'''''
**'''''required'''
**''''' a json encoded array of data to change for the given creative

== '''Example Request''' ==

'''PATCH'''
<nowiki>http://domain/api/creative/edit_creative</nowiki>

*Response: 
<pre>
array(2) {
  'result' =>
  string(7) "success"
  'message' =>
  string(3) "132"
}
</pre>
**''''' result will be error with the reason in message on failure

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

'''PHP'''
<pre>
<?php 
$url = 'http://domain/api/creative/edit_creative';

$creative_fields = Array(
	'name' => 'http://www.wpclipart.com/animals/aquatic/seal/seal_baby_clipart.png'
);

$creative_data = json_encode($creative_fields);

$data = array(
	'creative_id' => 1,
	'creative_data' => $creative_data
);

$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
); 
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
                                                   
$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]]