Create a custom field definition

Create a new custom field definition.

Required Fields:

• name - Field name
• type - DOCUMENT or CONTACT
• inputType - Input type (TEXT, NUMBER, DATE, CHECKBOX, SELECT, TEXTAREA)

Optional Fields:

• defaultValue - Default value for the field
• required - Whether field is required (default: false)
• options - For SELECT type, comma-separated options

POST /api/v1/custom-fields

Create a custom field definition

cURL

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",
  "required": false,
  "defaultValue": "<string>",
  "options": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "type": "DOCUMENT",
  "inputType": "TEXT",
  "defaultValue": "<string>",
  "required": true,
  "options": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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 string 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, JSON, TEXTAREA

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

application/json

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, JSON, TEXTAREA

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 · string<date-time> · required

Date and time when custom field was created

updatedAt · string<date-time> · required

Date and time when custom field was last updated