Skip to main content
POST
Create a list

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Path Parameters

entityType
enum<string>
required
Available options:
candidate,
client,
client-contact

Body

application/json
name
string
required
Minimum string length: 1
colorHex
string
required
Pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$
type
enum<string>
required
Available options:
PERSONAL,
WORKSPACE

Response

List created successfully. Returns the list ID.

id
string
required
Minimum string length: 1