Skip to main content
POST
/
v1
/
lists
Create List
curl --request POST \
  --url https://api.example.com/v1/lists \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "contact_count": 123,
    "created_at": "<string>"
  }
}

​
Request

​
Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json

​
Body Parameters

​
name
string
required
List name (must be unique within your workspace)
​
description
string
Optional description of the list’s purpose

​
Response

​
data
object
The created list object
curl -X POST \
  https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/lists \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Outreach Q2 2026",
    "description": "Prospects for Q2 campaign"
  }'

​
Example Response

{
  "data": {
    "id": "xyz98765-4321-abcd-ef01-234567890xyz",
    "name": "Outreach Q2 2026",
    "description": "Prospects for Q2 campaign",
    "contact_count": 0,
    "created_at": "2026-02-24T15:30:00Z"
  }
}

​
Errors

StatusCodeDescription
400validation_errorMissing required field or duplicate name
401invalid_keyInvalid API key
403insufficient_permissionsMissing write permission
429rate_limitedRate limit exceeded

​
Example Error (Duplicate Name)

{
  "error": {
    "code": "validation_error",
    "message": "A list with this name already exists",
    "details": {
      "fields": {
        "name": "Must be unique"
      }
    }
  }
}