Batch List Entry API Specifications

January 13, 2026 22:05

Use the Batch List Entry API to create or delete a group of list entries.

The Batch List Entry API is a REST HTTPS endpoint that uses OAuth 2.0 for authentication. Go to Batch List Entry for the swagger documentation.

Caution

Do not use the PolicyManager_BatchCreateEntries2 or PolicyManager_BatchDeleteEntries2 endpoints. Using these endpoints might result in an error.

Create Batch List Entry

Use the create batch entries endpoint to create up to 500 new list entries per request.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/lists/{listId}/entries:batchCreate

Production Endpoint

https://api.kount.com/policy-manager/v1/lists/{listId}/entries:batchCreate

Method: POST

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Create Batch Entries request parameters.

Note

When creating batch list entries, the request must be created based on the listType of the list you are adding to. The response will only contain properties related to that listType. For more information about each list type schema, go to Entry Schemas.

Create Batch List Entry request parameters

Create Bulk List Entry request example

Create Bulk List Entry response properties

sidebar. Create Bulk List Entry response properties table

JSON Path	Field Name	Description	Type	Example
version	Response Version	The version of the lists endpoint response contract used for this response, as a string containing a three-digit semantic version number.	String	"v1.0.0"
results	Results Array	An array of objects, each detailing the outcome for a single processed list entry.	Array
results[].id	Entry ID	The unique identifier for the entry that was targeted to be added.	String	"bWluZGxlVGVzdDgyMTExMw"
results[].status	Operation Status Code	The HTTP status code indicating the outcome of the operation for the specific entry, such as 200 for success, 400 for bad request, or 404 for not found.	Number	"200"
results[].message	Operation Message	A human-readable message describing the result of the operation.	String	“Update successful."
results[].errorCode	Error Code	A machine-readable code specifying the type of error. This field is only present on failure.	String	“INVALID_IP”
results[].entry	Entry Object	The original entry object from the request that was processed. The content of the object will follow the schema of the list type.	Object
summary	Summary Object	An object that provides a summary of the entire batch operation.	Object
summary.totalProcessed	Total Processed Count	The total number of entries that were processed in the batch.	Number	"3"
summary.successCount	Success Count	The total number of entries that were successfully processed.	Number	"1"
summary.failureCount	Failure Count	The total number of entries that failed to process.	Number	"2"

Create Bulk List Entry response example

sidebar. Create Bulk List Entry response example

{
  "version": "v1.9.0",
  "results": [
    {
      "id": "bWluZGxlVGVzdDgyMTExMw",
      "status": 400,
      "message": "Invalid IP value.",
      "errorCode": "INVALID_IP",
      "entry": {
        "userIpAddress": "192.168.1.1.7.9"
      }
    },
    {
      "id": "bWluZGxlVGVzdDgyMTExMw",
      "status": 404,
      "message": "Entry not found.",
      "errorCode": "NOT_FOUND",
      "entry": {
        "userIpAddress": "192.168.1.1"
      }
    }
  ],
  "summary": {
    "totalProcessed": 3,
    "successCount": 1,
    "failureCount": 2
  }
}

Delete Batch List Entry

Use the batch delete entries endpoint to delete multiple list entries in a single request.

Sandbox Endpoint

https://api-sandbox.kount.com/policy-manager/v1/lists/{listId}/entries:batchDelete

Production Endpoint

https://api.kount.com/policy-manager/v1/lists/{listId}/entries:batchDelete

Method: POST

Header Authorization: Bearer token

Header Content-Type: application/json

Body: Refer to the Delete Batch List Entry request parameters.

Delete Batch List Entry request parameters

Delete Bulk List Entry request example

Delete Batch List Entry response properties

sidebar. Delete Batch List Entry response properties table

JSON Path	Field Name	Description	Type	Example
version	Response Version	The version of the lists endpoint response contract used for this response, as a string containing a three-digit semantic version number.	String	"v1.9.0"
results	Results Array	An array of objects, each detailing the outcome for a single processed list entry.	Array
results[].id	Entry ID	The unique identifier for the entry that was targeted to be added.	String	"bWluZGxlVGVzdDgyMTExMw"
results[].status	Operation Status Code	The HTTP status code indicating the outcome of the operation for the specific entry, such as 200 for success, 400 for bad request, or 404 for not found.	Number	"200"
results[].message	Operation Message	A human-readable message describing the result of the operation.	String	“Deletion successful."
results[].errorCode	Error Code	A machine-readable code specifying the type of error. This field is only present on failure.	String	“NOT_FOUND”
summary	Summary Object	An object that provides a summary of the entire batch operation.	Object
summary.totalProcessed	Total Processed Count	The total number of entries that were processed in the batch.	Number	"3"
summary.successCount	Success Count	The total number of entries that were successfully processed.	Number	"1"
summary.failureCount	Failure Count	The total number of entries that failed to process.	Number	"2"

Delete Bulk List Entry response example

Was this article helpful?

0 out of 0 found this helpful