Segments - Optout Segments



Endpoint

POST /v1.1/optout/segment/[SegmentID]

Description

Opt a member out of your segment list.

Parameters
required *

apiKey *  string Your API access key
[segmentid] *  integer The ID of the segment for opt out
id *  integer The ID of the user to opt out.

Sign in with your developer account to use the console, or sign up here

Example Request

curl -X POST "https://api.theappreciationengine.com/v1.1/optout/segment/321?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&id=123456"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/optout/segment/321?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&id=123456", 
	CURLOPT_RETURNTRANSFER => true, 
	CURLOPT_ENCODING => "", 
	CURLOPT_MAXREDIRS => 10, 
	CURLOPT_TIMEOUT => 0, 
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 
	CURLOPT_CUSTOMREQUEST => "POST", 
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://api.theappreciationengine.com/v1.1/optout/segment/321?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&id=123456"

headers = {}
payload = {}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text.encode('utf8'))
var request = require('request');
var options = {
	'method': 'POST',
	'url': 'https://api.theappreciationengine.com/v1.1/optout/segment/321?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&id=123456',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"status": "OK"
}