Skip to main content
POST
/
api
/
v1
/
custom-fields
Create a custom field definition
curl --request POST \
  --url https://app.sajn.se/api/v1/custom-fields \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "name": "<string>",
  "type": "DOCUMENT",
  "inputType": "TEXT",
  "defaultValue": "<string>",
  "required": false,
  "options": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "type": "DOCUMENT",
  "inputType": "TEXT",
  "defaultValue": "<string>",
  "required": true,
  "options": "<string>",
  "createdAt": "<any>",
  "updatedAt": "<any>"
}

Headers

​
authorization
string
required

Bearer token for API authentication

Body

application/json

Body

Create custom field request

​
name
string
required

Custom field name (required)

Minimum length: 1
​
type
enum<string>
required

Field type: DOCUMENT or CONTACT (required)

Available options:
DOCUMENT,
CONTACT
​
inputType
enum<string>
required

Input type (required): TEXT, NUMBER, DATE, CHECKBOX, SELECT, TEXTAREA, EMAIL, PHONE, or URL

Available options:
TEXT,
NUMBER,
DATE,
EMAIL,
PHONE,
URL,
BOOLEAN,
SELECT
​
required
boolean
default:false
required

Whether this field is required (default: false)

​
defaultValue
string | null

Default value for this field

​
options
string | null

Comma-separated options for SELECT type fields

Response

200

​
id
string
required

Unique custom field identifier

​
name
string
required

Custom field name

​
type
enum<string>
required

Field type: DOCUMENT or CONTACT

Available options:
DOCUMENT,
CONTACT
​
inputType
enum<string>
required

Input type: TEXT, NUMBER, DATE, CHECKBOX, SELECT, TEXTAREA, EMAIL, PHONE, or URL

Available options:
TEXT,
NUMBER,
DATE,
EMAIL,
PHONE,
URL,
BOOLEAN,
SELECT
​
defaultValue
string | null
required

Default value for this field

​
required
boolean
required

Whether this field is required

​
options
string | null
required

Comma-separated options for SELECT type fields

​
createdAt
any
required

Date and time when custom field was created

​
updatedAt
any
required

Date and time when custom field was last updated

⌘I