Difference between revisions of "Offerit REST API Activate Offer"
From Offerit
OfferitDave (talk | contribs) (→Example Code) |
OfferitRob (talk | contribs) |
||
Line 24: | Line 24: | ||
*offerid: the id of the offer to be activated | *offerid: the id of the offer to be activated | ||
**'''''type: integer''''' | **'''''type: integer''''' | ||
− | **required | + | **'''''required''''' |
+ | |||
+ | == '''Example Request''' == | ||
+ | |||
+ | '''PATCH''' | ||
+ | |||
+ | <nowiki>http://domain/api/offer/activate_offer</nowiki> | ||
+ | |||
+ | |||
+ | *Response: | ||
+ | <pre> | ||
+ | { | ||
+ | "result": "success", | ||
+ | "message": "Offer activated." | ||
+ | } | ||
+ | </pre> | ||
== '''Example Code''' == | == '''Example Code''' == |
Revision as of 12:39, 23 March 2017
GET /offer/activate_offer
Description
- Offerit supports an API resource to activate a paused/expired offer and allow traffic to the landing page url.
Resource URL
- http://domain/api/offer/activate_offer
- Replace domain with the Offerit domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
- offerid: the id of the offer to be activated
- type: integer
- required
Example Request
PATCH
http://domain/api/offer/activate_offer
- Response:
{ "result": "success", "message": "Offer activated." }
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'offerid' => 4, ); $data_string = http_build_query($data); $url = 'http://domain/api/offer/activate_offer?'.$data_string; $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"); $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); ?>