Members - Opt Out



Endpoint

POST /v1.1/optout

Description

Opt a member out of your global list

WARNING: This is a POST request and may remove data from your feed when testing.

Parameters
required *

apiKey *  string Your API access key
segment *  integer The ID of the Segment
id *  integer The ID of the user to opt in. Instead of id, you may provide email or partnerId/partnerCode combination

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?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321&id=123456"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/optout?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321&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?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321&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?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&segmentid=321&id=123456',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"data": {
"FirstName": "Jean Luc",
"Surname": "Picard",
"Email": "captjeanlucpicard@starfleet.com",
"Username": "JLP",
"Gender": "M",
"AccessToken": "034588732857",
"ID": 33333,
"AvatarURL": "http://someurl.com",
"Country": "",
"City": null,
"State": null,
"CountryCode": "",
"GeoCountry": null,
"VerifiedEmail": "captjeanlucpicard@starfleet.com"
},
"optins": [
{
"ID": "111",
"Type": "Brand",
"SegmentID": null,
"Label": null,
"Name": "Starfleet"
},
{
"ID": "1701",
"Type": "44444",
"SegmentID": "Segment",
"Label": null,
"Name": "Launching the new Enterprise"
}
],
"services": [
{
"Service": "spotify",
"Valid": "1",
"ActivitySharing": "1",
"ID": "55555",
"UserID": "1111",
"Username": "JLP",
"UserURL": null,
"Token": "asdf",
"TokenSecret": "asdfasdf",
"LastUpdated": null,
"LastLogin": "2364-05-05 16:40:57",
"VerifiedEmail": "captjeanlucpicard@starfleet.com",
"PaidAccount": "0",
"Followers": "0",
"Likes": "0",
"PartnerCode": null,
"PartnerID": null,
"Domains": [
"API"
]
}
],
"jwt": "eyJhbGciOiJSUzR5cCI6IkVcYl5CtReo-ulg6-xYOztp2fqYgp3pCY91RvSRDhAjhIsSoFDbfVHp4"
}