Apply an idempotent atomic bulk list change

cURL

curl --request POST \
  --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/lists/test/bulk' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: account-acct_7f3a9c' \
  --data '{
  "add": [
    {
      "kind": "email",
      "value": "throwaway.example",
      "action": "block",
      "note": "Signup burst from one domain",
      "expires_at": "2026-01-01T00:00:00Z"
    }
  ],
  "remove": [
    "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
  ]
}'

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.lists.change({
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: "test",
    idempotencyKey: "account-acct_7f3a9c",
    body: {
      add: [
        {
          kind: "email",
          value: "throwaway.example",
          action: "block",
          note: "Signup burst from one domain",
          expiresAt: "2026-01-01T00:00:00Z",
        },
      ],
      remove: [
        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
      ],
    },
  });

  console.log(result);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.lists.change(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", idempotency_key="account-acct_7f3a9c", add=[
        {
            "kind": "email",
            "value": "throwaway.example",
            "action": "block",
            "note": "Signup burst from one domain",
            "expires_at": "2026-01-01T00:00:00Z",
        },
    ], remove=[
        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    ])

    # Handle response
    print(res)

package main

import(
	"context"
	"os"
	noresponse "github.com/noresponsehq/go/v12"
	"github.com/noresponsehq/go/v12/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := noresponse.New(
        noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
    )

    res, err := s.Lists.Change(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "account-acct_7f3a9c", components.ListBulkRequest{
        Add: []components.ListEntryRequest{
            components.ListEntryRequest{
                Kind: components.ListEntryKindEmail,
                Value: "throwaway.example",
                Action: components.ListEntryActionBlock,
                Note: noresponse.Pointer("Signup burst from one domain"),
                ExpiresAt: noresponse.Pointer("2026-01-01T00:00:00Z"),
            },
        },
        Remove: []string{
            "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.ChangeListsResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ListBulkRequest;
import org.noresponse.models.shared.ListEntryAction;
import org.noresponse.models.shared.ListEntryKind;
import org.noresponse.models.shared.ListEntryRequest;

public class Application {

    public static void main(String[] args) throws Exception {

        NoResponse sdk = NoResponse.builder()
                .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
            .build();

        ChangeListsResponse res = sdk.lists().change()
                .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .environment(KeyEnvironment.TEST)
                .idempotencyKey("account-acct_7f3a9c")
                .body(ListBulkRequest.builder()
                    .add(List.of(
                        ListEntryRequest.builder()
                            .kind(ListEntryKind.EMAIL)
                            .value("throwaway.example")
                            .action(ListEntryAction.BLOCK)
                            .note("Signup burst from one domain")
                            .expiresAt("2026-01-01T00:00:00Z")
                            .build()))
                    .remove(List.of(
                        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM"))
                    .build())
                .call();

        if (res.listChange().isPresent()) {
            System.out.println(res.listChange().get());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

var res = await sdk.Lists.ChangeAsync(
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: KeyEnvironment.Test,
    body: new ListBulkRequest() {
        Add = new List<ListEntryRequest>() {
            new ListEntryRequest() {
                Kind = ListEntryKind.Email,
                Value = "throwaway.example",
                Action = ListEntryAction.Block,
                Note = "Signup burst from one domain",
                ExpiresAt = "2026-01-01T00:00:00Z",
            },
        },
        Remove = new List<string>() {
            "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
        },
    },
    idempotencyKey: "account-acct_7f3a9c"
);

// handle response

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use NoResponse;
use NoResponse\Models\Shared;

$sdk = NoResponse\NoResponseClient::builder()
    ->setSecurity(
        getenv('NORESPONSE_API_KEY') ?: ''
    )
    ->build();

$body = new Shared\ListBulkRequest(
    add: [
        new Shared\ListEntryRequest(
            kind: Shared\ListEntryKind::Email,
            value: 'throwaway.example',
            action: Shared\ListEntryAction::Block,
            note: 'Signup burst from one domain',
            expiresAt: '2026-01-01T00:00:00Z',
        ),
    ],
    remove: [
        'lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    ],
);

$response = $sdk->lists->change(
    workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    environment: Shared\KeyEnvironment::Test,
    body: $body,
    idempotencyKey: 'account-acct_7f3a9c'

);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.lists.change(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, body: Models::Shared::ListBulkRequest.new(
  add: [
    Models::Shared::ListEntryRequest.new(
      kind: Models::Shared::ListEntryKind::EMAIL,
      value: 'throwaway.example',
      action: Models::Shared::ListEntryAction::BLOCK,
      note: 'Signup burst from one domain',
      expires_at: '2026-01-01T00:00:00Z'
    ),
  ],
  remove: [
    'lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
  ]
), idempotency_key: 'account-acct_7f3a9c')

unless res.nil?
  # handle response
end

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "state": "propagating",
  "added": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "environment": "live",
      "kind": "email",
      "value": "<string>",
      "action": "block",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "note": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "removed": [
    "<string>"
  ],
  "pending_propagations": 1,
  "processed_account_references": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "invalid_request",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "unauthorized",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "workspace_forbidden",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "not_found",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "idempotency_key_reused",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "payload_too_large",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "unsupported_media_type",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

POST

workspaces

{workspace_id}

lists

{environment}

bulk

cURL

curl --request POST \
  --url 'https://api.noresponse.org/v1/workspaces/tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM/lists/test/bulk' \
  --header "Authorization: Bearer $NORESPONSE_API_KEY" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: account-acct_7f3a9c' \
  --data '{
  "add": [
    {
      "kind": "email",
      "value": "throwaway.example",
      "action": "block",
      "note": "Signup burst from one domain",
      "expires_at": "2026-01-01T00:00:00Z"
    }
  ],
  "remove": [
    "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM"
  ]
}'

import { NoResponse } from "@noresponse/node";

const noResponse = new NoResponse({
  apiKey: process.env["NORESPONSE_API_KEY"] ?? "",
});

async function run() {
  const result = await noResponse.lists.change({
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: "test",
    idempotencyKey: "account-acct_7f3a9c",
    body: {
      add: [
        {
          kind: "email",
          value: "throwaway.example",
          action: "block",
          note: "Signup burst from one domain",
          expiresAt: "2026-01-01T00:00:00Z",
        },
      ],
      remove: [
        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
      ],
    },
  });

  console.log(result);
}

run();

from noresponse import NoResponse
import os


with NoResponse(
    api_key=os.getenv("NORESPONSE_API_KEY", ""),
) as no_response:

    res = no_response.lists.change(workspace_id="tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", environment="test", idempotency_key="account-acct_7f3a9c", add=[
        {
            "kind": "email",
            "value": "throwaway.example",
            "action": "block",
            "note": "Signup burst from one domain",
            "expires_at": "2026-01-01T00:00:00Z",
        },
    ], remove=[
        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    ])

    # Handle response
    print(res)

package main

import(
	"context"
	"os"
	noresponse "github.com/noresponsehq/go/v12"
	"github.com/noresponsehq/go/v12/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := noresponse.New(
        noresponse.WithSecurity(os.Getenv("NORESPONSE_API_KEY")),
    )

    res, err := s.Lists.Change(ctx, "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM", components.KeyEnvironmentTest, "account-acct_7f3a9c", components.ListBulkRequest{
        Add: []components.ListEntryRequest{
            components.ListEntryRequest{
                Kind: components.ListEntryKindEmail,
                Value: "throwaway.example",
                Action: components.ListEntryActionBlock,
                Note: noresponse.Pointer("Signup burst from one domain"),
                ExpiresAt: noresponse.Pointer("2026-01-01T00:00:00Z"),
            },
        },
        Remove: []string{
            "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

package hello.world;

import java.lang.Exception;
import java.util.List;
import org.noresponse.NoResponse;
import org.noresponse.models.errors.AuthenticationException;
import org.noresponse.models.errors.BadRequestException;
import org.noresponse.models.errors.ConflictException;
import org.noresponse.models.errors.NotFoundException;
import org.noresponse.models.errors.PermissionDeniedException;
import org.noresponse.models.errors.RateLimitException;
import org.noresponse.models.operations.ChangeListsResponse;
import org.noresponse.models.shared.KeyEnvironment;
import org.noresponse.models.shared.ListBulkRequest;
import org.noresponse.models.shared.ListEntryAction;
import org.noresponse.models.shared.ListEntryKind;
import org.noresponse.models.shared.ListEntryRequest;

public class Application {

    public static void main(String[] args) throws Exception {

        NoResponse sdk = NoResponse.builder()
                .apiKey(System.getenv().getOrDefault("NORESPONSE_API_KEY", ""))
            .build();

        ChangeListsResponse res = sdk.lists().change()
                .workspaceId("tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM")
                .environment(KeyEnvironment.TEST)
                .idempotencyKey("account-acct_7f3a9c")
                .body(ListBulkRequest.builder()
                    .add(List.of(
                        ListEntryRequest.builder()
                            .kind(ListEntryKind.EMAIL)
                            .value("throwaway.example")
                            .action(ListEntryAction.BLOCK)
                            .note("Signup burst from one domain")
                            .expiresAt("2026-01-01T00:00:00Z")
                            .build()))
                    .remove(List.of(
                        "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM"))
                    .build())
                .call();

        if (res.listChange().isPresent()) {
            System.out.println(res.listChange().get());
        }
    }
}

using NoResponse;
using NoResponse.Models.Shared;
using System;
using System.Collections.Generic;

var sdk = new NoResponseClient(apiKey: Environment.GetEnvironmentVariable("NORESPONSE_API_KEY"));

var res = await sdk.Lists.ChangeAsync(
    workspaceId: "tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
    environment: KeyEnvironment.Test,
    body: new ListBulkRequest() {
        Add = new List<ListEntryRequest>() {
            new ListEntryRequest() {
                Kind = ListEntryKind.Email,
                Value = "throwaway.example",
                Action = ListEntryAction.Block,
                Note = "Signup burst from one domain",
                ExpiresAt = "2026-01-01T00:00:00Z",
            },
        },
        Remove = new List<string>() {
            "lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM",
        },
    },
    idempotencyKey: "account-acct_7f3a9c"
);

// handle response

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use NoResponse;
use NoResponse\Models\Shared;

$sdk = NoResponse\NoResponseClient::builder()
    ->setSecurity(
        getenv('NORESPONSE_API_KEY') ?: ''
    )
    ->build();

$body = new Shared\ListBulkRequest(
    add: [
        new Shared\ListEntryRequest(
            kind: Shared\ListEntryKind::Email,
            value: 'throwaway.example',
            action: Shared\ListEntryAction::Block,
            note: 'Signup burst from one domain',
            expiresAt: '2026-01-01T00:00:00Z',
        ),
    ],
    remove: [
        'lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    ],
);

$response = $sdk->lists->change(
    workspaceId: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
    environment: Shared\KeyEnvironment::Test,
    body: $body,
    idempotencyKey: 'account-acct_7f3a9c'

);

$result = $response->result;
// handle response

require 'noresponse'

Models = ::NoResponse::Models
s = ::NoResponse::NoResponseClient.new(
  api_key: ENV.fetch('NORESPONSE_API_KEY', '')
)
res = s.lists.change(workspace_id: 'tnt_01JA2Z8K6Q4V7W9XBCDEFGHJKM', environment: Models::Shared::KeyEnvironment::TEST, body: Models::Shared::ListBulkRequest.new(
  add: [
    Models::Shared::ListEntryRequest.new(
      kind: Models::Shared::ListEntryKind::EMAIL,
      value: 'throwaway.example',
      action: Models::Shared::ListEntryAction::BLOCK,
      note: 'Signup burst from one domain',
      expires_at: '2026-01-01T00:00:00Z'
    ),
  ],
  remove: [
    'lst_01JA2Z8K6Q4V7W9XBCDEFGHJKM',
  ]
), idempotency_key: 'account-acct_7f3a9c')

unless res.nil?
  # handle response
end

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "state": "propagating",
  "added": [
    {
      "id": "<string>",
      "workspace_id": "<string>",
      "environment": "live",
      "kind": "email",
      "value": "<string>",
      "action": "block",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "note": "<string>",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "removed": [
    "<string>"
  ],
  "pending_propagations": 1,
  "processed_account_references": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "invalid_request",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "unauthorized",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "workspace_forbidden",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "not_found",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 409,
  "detail": "<string>",
  "code": "idempotency_key_reused",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 413,
  "detail": "<string>",
  "code": "payload_too_large",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 415,
  "detail": "<string>",
  "code": "unsupported_media_type",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "service_unavailable",
  "request_id": "<string>",
  "instance": "<string>",
  "invalid_params": [
    {
      "field": "<string>",
      "reason": "<string>",
      "example": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Your API key, sent as Authorization: Bearer <key>. A key is nrk_live_ or nrk_test_, a 26-character key id, _ and a 43-character secret. Account, audit and usage data stay within the key's environment. Dedicated team scopes apply across the workspace.

assess creates and reads assessments, records outcomes and reports key usage. investigate reads accounts, assessment history and request diagnostics without export or enforcement access. The legacy history scope also permits account exports, submitted identifiers and enforcement reports. delete permits account and assessment deletion.

evidence or detailed adds detailed merged evidence and submitted identifiers where the operation permits them. Neither grants access to the underlying resource alone. exports permits exports with the underlying account or audit scope. audit reads audit events and usage reads usage. audit_manage manages audit streams and retention, and includes audit-read and export authority.

webhooks manages webhook endpoints. integrations manages hosted auth-provider integrations. management manages keys, settings, lists, reviews and policy evaluations in the key's environment. New keys cannot exceed the issuer's effective permissions.

settings reads configuration, previews policy and list changes, runs evaluations and changes retention. Publishing decision policy or changing lists requires settings and policy_publish together, or the legacy management scope.

groups creates and reads groups, adds people, starts and cancels screenings and records decisions on people, in the key's environment.

members reads the workspace directory. members_manage also administers non-owner members and invitations. These scopes require a live key issued by a current owner with access to both environments. They grant access across the workspace. management does not grant team access. API keys cannot change owners or accept invitations.

A missing, unknown, revoked or expired key answers 401. A valid key without a required scope answers 403.

Headers

Idempotency-Key

string

required

Opaque client key, 16 to 128 characters of [A-Za-z0-9._:-] (a UUID or ULID fits). Scoped to the workspace principal and bound to the canonical body for 24 hours.

Required string length: 16 - 128

Pattern: ^[A-Za-z0-9._:-]{16,128}$

Path Parameters

workspace_id

string

required

The workspace id. A workspace the acting user is not an active member of answers 404, as do another workspace than an API key's own, a malformed id and a test environment's id. The workspace id, which is also its live environment's workspace id; the test environment's is the same id with:test appended. A workspace created through the API is tnt_ and a 26-character ULID.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,122}$

environment

enum<string>

required

The environment: live or test. Each has its own settings. Any other value answers 400. An API key reads and changes only its own environment's; the other answers 404. The environment the key belongs to. A live key assesses with live sources; a test key answers from the deterministic simulator.

Available options:

live,

test

Body

application/json

Atomic bulk list change
Atomic bulk list change

At most 100 additions and removals combined. One transaction applies all changes or none. Idempotency-Key prevents duplicate changes for 24 hours; a different body under the same key returns 409. Matching reads see the new list immediately, while bounded durable jobs propagate account risk notifications.

add

List entry request · object[]

required

Required array length: 1 - 100 elements

Show child attributes

remove

string[]

Required array length: 1 - 100 elements

Pattern: ^lst_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response

Apply an idempotent atomic bulk list change.

A committed bulk list change and bounded notification progress, available while propagation is pending and for 24 hours after all propagation completes. References count an account once per changed list entry and are not unique accounts. No endpoint delivery or customer enforcement is implied by completed.

string

required

Pattern: ^lch_[0-7][0-9A-HJKMNP-TV-Z]{25}$

created_at

string<date-time>

required

state

enum<string>

required

Available options:

propagating,

completed

added

List entry · object[]

required

Maximum array length: 100

Show child attributes

removed

string[]

required

Maximum array length: 100

Pattern: ^lst_[0-7][0-9A-HJKMNP-TV-Z]{25}$

pending_propagations

integer

required

Required range: x >= 0

processed_account_references

integer

required

Required range: x >= 0

Overview

Using the API

Endpoints

Errors

Apply an idempotent atomic bulk list change

Authorizations

Headers

Path Parameters

Body

Response