Remove a Contact from one or multiple Segments.

Request

POST https://api.platform.ly

Method: contact_segment_remove

Request Body

{
  "api_key":"xxxxxxxxxxxxx",            //required
  "action": "contact_segment_remove",   //required
  "value": {
    "contact_id": 0,                    //required *
    "email": "john.smith@gmail.com",    //required *
    "segment": 0                        //required
  }
}

curl --location --request POST 'https://api.platform.ly' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'api_key=xxxxxxxxxxxxx' \
--data-urlencode 'action=contact_segment_remove' \
--data-urlencode 'value={"email": "john.smith@gmail.com","segment": "0"}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.platform.ly',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'api_key=xxxxxxxxxxxxx&action=contact_segment_remove&value=%7B%22email%22%3A%20%22john.smith%40gmail.com%22%2C%22segment%22%3A%20%220%22%7D',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://api.platform.ly"

payload='api_key=xxxxxxxxxxxxx&action=contact_segment_remove&value=%7B%22email%22%3A%20%22john.smith%40gmail.com%22%2C%22segment%22%3A%20%220%22%7D'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}

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

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "api_key=xxxxxxxxxxxxx&action=contact_segment_remove&value={\"email\": \"john.smith@gmail.com\",\"segment\": \"0\"}");
Request request = new Request.Builder()
  .url("https://api.platform.ly")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();

Request Format

api_key required
Authentication API Key. Where can I find my API Key?

action required
contact_segment_remove

value required
JSON formatted string with additional request values

contact_id required *
Contact ID.

email required *
Valid Contact Email Address

segment required
Segment IDs separated by comma.Where can I find my Segment ID?

* At least one of the following fields is required: contact_id, email

Response

Returns a JSON success object if the request succeeded. Returns an error if the request parameters are invalid.

👍
200 OK

{
    "status": "success",
    "message": "The action has been processed"
}