Accounts2

AI Analysis2

Bank Accounts1

Batches4

Cases8

Custom Lists8

Diagnostics1

Documents9

Entities10

Entity Feedback2

Entity Groups1

Evaluations5

Events3

Groups3

Investigations24

Journeys20

Lists6

OAuth2

Portfolio Evaluations2

Published Attributes6

Reviews6

Transactions2

Lists

Replace the entire List

Changed on Nov 3, 2026

Overwrite the entire List with the contents of the submitted array

put/lists/{list_token}

Request

Base URL
https://sandbox.alloy.co/v1
Auth
- OAuth 2
  Client credentials
  Token URL/oauth/bearer
- or HTTP basic
TypeScript
https://skmtc.dev/alloy/apis/alloy-api/docs/lists/:list_token/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

name_firststring

name_laststring

birth_datestring

document_ssnstring

address_line_1string

address_line_2string

address_citystring

address_statestring

address_postal_codestring

address_country_codestring

ip_address_v4string

ip_address_v6string

email_addressstring

phone_numberstring

acm_party_idstring

customer_idstring

systemstring

security_questionstring

security_answerstring

commentstring

device_aliasstring

digital_profile_uuidstring

smart_uuidstring

session_uuidstring

fingerprint_uuidstring

external_counterparty_idstring

expires_atstring date-time

timestamp of when the list row will not be used

Example request

[
  {
    "name_first": "John",
    "name_last": "Doe",
    "birth_date": "1980-01-01",
    "document_ssn": 123321123,
    "address_line_1": "123 Fake Street",
    "address_line_2": "Apt 10D",
    "address_city": "Brooklyn",
    "address_state": "NY",
    "address_postal_code": 11221,
    "address_country_code": "US",
    "ip_address_v4": "192.168.1.168",
    "ip_address_v6": null,
    "email_address": "john.doe@gmail.com",
    "phone_number": 5558031203,
    "acm_party_id": 12341231,
    "customer_id": 1249403039484,
    "system": "bridger",
    "security_question": "what is your quest",
    "security_answer": "to seek the holy grail",
    "comment": "this is a comment",
    "expires_at": "2023-09-01T00:00:00.000Z"
  }
]

Response

Successfully replaced List

status_codenumber

errorobject

timestampinteger

namestring

list_tokenstring

datastring

records_addedinteger

total_recordsinteger

Example response

{
  "status_code": 200,
  "error": null,
  "timestamp": 1557675468774,
  "name": "Denylisted entities",
  "list_token": "I-grYZsEoy623M3LiZrK66",
  "data": "https://sandbox.alloy.co/lists/I-grYZsEoy623M3LiZrK66",
  "records_added": 1,
  "total_records": 1
}

Changes

Nov 3, 2026615aa97a5ddb Revision changes
- breaking
  the request property type changed from no type to object
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /

Operation history