Create List

Creates a new list with the specified name

POST /list/{list_name}

Try it

cURL

cURL

curl --request POST \
  --url https://api.sandbox.verisoul.ai/list/{list_name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "list_description": "<string>"
}
'

200

{
  "request_id": "83310a37-aec5-4aa5-8e1b-edf4916128ae",
  "message": "List us_users created",
  "success": true
}

Authorizations

x-api-key · string · header · required

Path Parameters

list_name · string · required

Name of the list to create

Body

application/json

List information

list_description · string

Description of the list's purpose

Response

200

application/json

List creation response

request_id · string

The ID of the request

message · string

Success message

success · boolean

Whether the operation was successful