Modify a people list

What it does

Adds or removes people in an existing people list.

Why you’d use it

Keep a curated contact cohort current as your pipeline changes.

Key behaviors

• Supports adding and removing people in a single request (per the request schema on this page).
• To create a new list and add people in one step, use POST Create a new people list.

The list must be shared with the API to be modifiable.

PATCH /lists/people/{listId}

Modify a people list

cURL

curl --request PATCH \
  --url https://app.tryspecter.com/api/v1/lists/people/{listId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "add_ids": [
    "per_5e3a7f2b0aa7a3270a55f2a7"
  ],
  "delete_ids": [
    "per_5e3a7f2b0aa7a3270a55f2a7"
  ]
}
'

import requests

url = "https://app.tryspecter.com/api/v1/lists/people/{listId}"

payload = {
    "add_ids": ["per_5e3a7f2b0aa7a3270a55f2a7"],
    "delete_ids": ["per_5e3a7f2b0aa7a3270a55f2a7"]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    add_ids: ['per_5e3a7f2b0aa7a3270a55f2a7'],
    delete_ids: ['per_5e3a7f2b0aa7a3270a55f2a7']
  })
};

fetch('https://app.tryspecter.com/api/v1/lists/people/{listId}', 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://app.tryspecter.com/api/v1/lists/people/{listId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'add_ids' => [
        'per_5e3a7f2b0aa7a3270a55f2a7'
    ],
    'delete_ids' => [
        'per_5e3a7f2b0aa7a3270a55f2a7'
    ]
  ]),
  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://app.tryspecter.com/api/v1/lists/people/{listId}"

	payload := strings.NewReader("{\n  \"add_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"delete_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.tryspecter.com/api/v1/lists/people/{listId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"add_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"delete_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.tryspecter.com/api/v1/lists/people/{listId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"add_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ],\n  \"delete_ids\": [\n    \"per_5e3a7f2b0aa7a3270a55f2a7\"\n  ]\n}"

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

200

{
  "id": "b73c8bed-3b92-48f9-a879-40ee114dca03",
  "name": "Favourites",
  "created_at": "2024-11-14T10:36:12.625Z",
  "updated_at": "2024-11-14T10:36:12.625Z",
  "people": [
    {
      "person_id": "per_2f3c7fe468ec9fc2181bec8b",
      "created_at": "2025-01-02T17:29:46.688Z"
    }
  ]
}

{
  "errorCode": "INVALID_LIST_UUID",
  "message": "List id must be a valid UUID."
}

{
  "errorCode": "API_KEY_MISSING",
  "message": "No API Key was presented on the header X-API-KEY"
}

{
  "errorCode": "NOT_PERMITTED",
  "message": "You do not have permission to access this resource."
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

listId · string<uuid> · required

The ID of the list being requested.

Body

application/json

Request to add and delete ids

add_ids · string[]

List of people to add to the list

ID of person being added

delete_ids · string[]

List of people to remove from the list

ID of person being removed

Response

200

application/json

The list including people ids

id · string

List Id

Example:

"b73c8bed-3b92-48f9-a879-40ee114dca03"

name · string

Name of the list

Example:

"Favourites"

created_at · string<date-time>

Date list was created

Example:

"2024-11-14T10:36:12.625Z"

updated_at · string<date-time>

Date the list was last updated

Example:

"2024-11-14T10:36:12.625Z"

people · object[]

The people included in this list

Show child attributes