Create a new field in a list

post

https://api.salesautopilot.com/v2/lists/{listId}/fields

Creates a new custom field in the specified list.

Field Name Rules

The name property is the technical database column name. It must:

Start with a lowercase letter (a–z) — uppercase letters, digits and underscores are not allowed as the first character
Contain only lowercase letters (a–z), digits (0–9), or underscores (_)
Be between 5 and 64 characters long
Be unique within the list

Type-Specific Behavior

CHECKBOX: The defaultValue must be "0" or "1" if provided
DATE: The defaultValue must be a valid date in YYYY-MM-DD format if provided; otherwise defaults to 0000-00-00
DATETIME: The defaultValue must be YYYY-MM-DD HH:MM:SS format if provided; otherwise defaults to 0000-00-00 00:00:00
NUMBER: Defaults to 0 if no defaultValue is provided
DECIMAL: Defaults to 0.00 if no defaultValue is provided

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

listId

integer

required

The ID of the list in which to create the field

Body Params

Use this schema when creating a SELECT or RADIO field. The options array defines the selectable choices.

type

string

enum

required

The data type of the field. Determines which schema variant applies:

SELECT and RADIO → use the "SELECT or RADIO field" variant (supports options)
All other types → use the "Other field types" variant

Allowed:

label

string

required

length ≥ 1

The human-readable display name of the field

name

string

required

length between 5 and 64

^[a-z][a-z0-9_]*$

The technical name used as the database column name.
Must start with a lowercase letter (a–z), contain only lowercase letters (a–z), digits (0–9) or underscores (_),
and be between 5 and 64 characters long. Must be unique within the list.

defaultValue

string | null

The default value for the field. Type-specific rules apply:

CHECKBOX: must be "0" or "1"
DATE: must be YYYY-MM-DD format
DATETIME: must be YYYY-MM-DD HH:MM:SS format

comment

string | null

An optional internal comment or description for the field

options

array of objects

List of selectable options. Each item must have a value (stored in the database)
and a text (displayed to the user).

options

Responses

200Field created successfully

400Validation error

401Missing or invalid authentication token

404List not found

409Field name already exists in the list

429Rate limit exceeded

500Internal server error