Skip to main content
POST
Add a field

Authorizations

x-token
string
header
required

Path Parameters

boardId
string
required

Body

application/json
name
string
required
type
enum<string>
required

The field types that can be created through the API (POST /api/boards and POST /api/board/{boardId}/configuration/fields). The value column is what a card stores and what the card API (POST /api/board/{boardId}) accepts under the field's uuid.

Relational and system types (relatedAptlets, mirror, location, unit, stageselect, calculation, and similar) can't be created through the API; boards built in the Aptly app can still contain them and they appear when reading fields.

Available options:
string,
text,
rich-text,
number,
money,
percent,
multiplier,
boolean,
date,
datetime-local,
email,
emails,
tel,
phones,
url,
address,
person,
persons,
user,
file,
files,
heroImage,
embedVideo,
stringList,
tags,
singleselect,
multiselect,
checkboxlist
uuid
string

Optional key; must match ^[a-zA-Z][a-zA-Z0-9_]{0,63}$. Generated when omitted.

optional
boolean
pinned
boolean
defaultValue
string
data
object[]

Required (non-empty) for singleselect and multiselect.

Response

The created field.

data
object