NATS For Networks REST Set Offer Groups

From TMM Wiki
Revision as of 14:54, 19 April 2017 by Tmmdavid (talk | contribs) (Created page with "{{NATS For Networks Manual | show_api_admin_section = true }} == '''PATCH /offer/set_offer_groups''' == '''Description''' *set_offer_groups updates the offer groups associat...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Template:NATS For Networks Manual

PATCH /offer/set_offer_groups

Description

  • set_offer_groups updates the offer groups associated with an offer


Resource URL

  • http://domain/api/offer/set_offer_groups
  • Replace domain with the NATS For Networks domain

Response Format

  • JSON

Request Method

  • PATCH

Authentication

  • HTTP headers

Parameters

  • offerid
    • type: int
    • required
    • The offer to update
  • offer_groups
    • type: array,string'
    • required
    • Array or comma separated list of offer group ids to associate with this offer
  • append
    • type: bool
    • Adds to existing offer groups. Default is to replace them.



Example Request

PATCH


http://domain/api/offer/set_offer_groups
offerid=2
offer_groups=1,


  • Response:
{
    "result":"Success",
}

Example Code

PHP

<?php 
$url = 'http://domain/api/offer/set_offer_groups';
$curl = curl_init(); 
 
$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);

 $data = Array(
    'offerid' => 2,
    'offer_groups' => Array(1,2)
); 

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); 
?>