Difference between revisions of "NATS For Networks REST API Pause Offer"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS for Networks Manual | show_rest_api_section = true }} == '''GET /offer/pause_offer''' == '''Description''' *NATS for Networks supports an API resource to pause an off...") |
|||
Line 34: | Line 34: | ||
*expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent) | *expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent) | ||
**'''''type: string''''' | **'''''type: string''''' | ||
+ | |||
+ | == '''Example Request''' == | ||
+ | |||
+ | '''PATCH''' | ||
+ | |||
+ | <nowiki>http://domain/api/offer/pause_offer</nowiki> | ||
+ | |||
+ | |||
+ | *Response: | ||
+ | <pre> | ||
+ | { | ||
+ | "result": "success", | ||
+ | "message": "Offer expired." | ||
+ | } | ||
+ | </pre> | ||
+ | |||
== '''Example Code''' == | == '''Example Code''' == |
Revision as of 12:46, 23 March 2017
GET /offer/pause_offer
Description
- NATS for Networks supports an API resource to pause an offer and send the traffic to another offer/landing page or expiration url.
Resource URL
- http://domain/api/offer/pause_offer
- Replace domain with the NATS for Networks domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
- offerid: the id of the offer to be paused
- type: integer
- required
- date_expire: date or unix timestamp to set as the expiration date. Leaving this blank will make the expiration immediate
- type: string
- expiration_landing_page_id: the id of the landing page you want the traffic redirected to
- type: integer
- expire_url: the expiration url you want traffic redirected to (expiration_landing_page_id takes precedence over this if both are sent)
- type: string
Example Request
PATCH
http://domain/api/offer/pause_offer
- Response:
{ "result": "success", "message": "Offer expired." }
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'offerid' => 4, 'date_expire' => '2017/03/20', 'expiration_landing_page_id' => 17 ); $data_string = http_build_query($data); $url = 'http://domain/api/offer/pause_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); $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); ?>