Skip to main content
POST
Create a custom field

Authorizations

Authorization
string
header
required

API key from Settings > Developer. Format: alva_sk_...

Body

application/json
entityType
enum<string>
required
Available options:
company,
contact
label
string
required
fieldType
enum<string>
required
Available options:
text,
textarea,
number,
boolean,
date,
datetime,
select,
multi_select,
url,
email,
phone,
currency
key
string

Optional. Auto-derived from label when omitted; immutable afterwards.

options
string[]

Required for select / multi_select

required
boolean
defaultValue
unknown
helpText
string | null

Response

CustomField

success
boolean
Example:

true

message
string

Human-readable confirmation of the action.

data
object
resource
string