Remove entries

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "records": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove"

payload = { "records": [{ "id": "<string>" }] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({records: [{id: '<string>'}]})
};

fetch('https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'records' => [
        [
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove"

	payload := strings.NewReader("{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": [
    {
      "status": "removed",
      "record": {
        "id": "<string>"
      },
      "entry": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "list_id": "<string>",
        "object": "<string>",
        "record_id": "<string>"
      }
    }
  ],
  "summary": {
    "total": 123,
    "removed": 123,
    "not_in_list": 123
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "forbidden",
  "message": "<string>"
}

{
  "status": "list_not_found",
  "message": "<string>"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

POST

data

lists

{list_id}

entries

remove

cURL

curl --request POST \
  --url https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "records": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove"

payload = { "records": [{ "id": "<string>" }] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({records: [{id: '<string>'}]})
};

fetch('https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'records' => [
        [
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove"

	payload := strings.NewReader("{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/data/v1/lists/{list_id}/entries/remove")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"records\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": [
    {
      "status": "removed",
      "record": {
        "id": "<string>"
      },
      "entry": {
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "list_id": "<string>",
        "object": "<string>",
        "record_id": "<string>"
      }
    }
  ],
  "summary": {
    "total": 123,
    "removed": 123,
    "not_in_list": 123
  }
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "forbidden",
  "message": "<string>"
}

{
  "status": "list_not_found",
  "message": "<string>"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

list_id

string

required

ID of the list. String UUIDv4 value.

Body

application/json

Request body for removing records from a list.

records

object[]

required

Up to 100 record identifiers to remove, processed in request order. ID and match identifiers may be mixed. Duplicate identifiers are not allowed.

Required array length: 1 - 100 elements

Record identifier using an ID or attribute values.

Option 1
Option 2

Show child attributes

Response

Response for removing records from a list.

status

enum<string>

required

Available options:

success

data

object[]

required

One result per requested record, in request order.

Result for a record removed from the list.

Option 1
Option 2

Show child attributes

summary

object

required

Counts of remove outcomes by status.

Show child attributes

⌘I

Unify Platform

MCP

Developer Guides

API Reference

SDKs

Remove entries

Authorizations

Path Parameters

Body

Response