Creates a new ValueList
object, which can then be referenced in rules.
Parameters
- aliasstringRequired
The name of the value list for use in rules.
- namestringRequired
The human-readable name of the value list.
- item_
typestring Type of the items in the value list. One of
card_
,fingerprint us_
,bank_ account_ fingerprint sepa_
,debit_ fingerprint card_
,bin email
,ip_
,address country
,string
,case_
, orsensitive_ string customer_
. Useid string
if the item type is unknown or mixed. - metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
Returns a ValueList
object if creation succeeds.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist"}
Updates a ValueList
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_
is immutable.
Parameters
- aliasstring
The name of the value list for use in rules.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
. - namestring
The human-readable name of the value list.
Returns
Returns an updated ValueList
object if a valid identifier was provided.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Updated IP Blocklist"}
Retrieves a ValueList
object.
Parameters
No parameters.
Returns
Returns a ValueList
object if a valid identifier was provided.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist"}
Returns a list of ValueList
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- aliasstring
The alias used to reference the value list when writing rules.
More parameters
- containsstring
- createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
lists, starting after list starting_
. Each entry in the array is a separate ValueList
object. If no more lists are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/radar/value_lists", "has_more": false, "data": [ { "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "alias": "custom_ip_blocklist", "created": 1680201894, "created_by": "API", "item_type": "ip_address", "list_items": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/radar/value_list_items?value_list=rsl_1MrQSwLkdIwHu7ixWOGS5c8M" }, "livemode": false, "metadata": {}, "name": "Custom IP Blocklist" } ]}
Deletes a ValueList
object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
Parameters
No parameters.
Returns
Returns an object with the deleted ValueList
object’s ID and a deleted parameter on success. Otherwise, this call raises an error.
{ "id": "rsl_1MrQSwLkdIwHu7ixWOGS5c8M", "object": "radar.value_list", "deleted": true}