Skip to main content
POST
Error

Authorizations

​
X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json
​
name
string
required

Display name of the saved field

​
type
enum<string>
required
Available options:
text,
signature,
initials,
date,
date_now,
checkbox,
select,
radio,
file,
image,
stamp,
payment,
phone_verification,
cells,
number
​
validation
enum<string> | null
Available options:
ssn,
ein,
email,
url,
zip,
zip_us,
numeric,
alpha,
alphanumeric,
phone_us,
phone_intl
​
pattern
string | null

Custom regex pattern for field validation

​
options
string[]

Options for select/radio field types

​
required
boolean
default:false

Response

Saved field created

​
id
integer
​
name
string
​
type
string
​
validation
string | null
​
pattern
string | null
​
options
string[] | null
​
required
boolean
​
created_at
string<date-time>