Skip to Content
Custom fields

Create a custom field definition

POST
/api/v1/custom-fields

Create a new custom field definition.

Required Fields:

  • name - Field name
  • type - DOCUMENT or CONTACT
  • inputType - Input type (TEXT, NUMBER, DATE, BOOLEAN, SELECT, TEXTAREA, EMAIL, PHONE, URL, JSON)

Optional Fields:

  • defaultValue - Default value for the field
  • required - Whether field is required (default: false)
  • options - For SELECT type, the options as an array of strings, for example ["Small","Large"]

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key?string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Lengthlength <= 255

Request Body

Body

application/json
  1. body

Create custom field request

name*string

Custom field name (required)

Length1 <= length
type*string

Field type: DOCUMENT or CONTACT (required)

Value in"DOCUMENT""CONTACT"
inputType*string

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

Value in"TEXT""NUMBER""DATE""EMAIL""PHONE""URL""BOOLEAN""SELECT""JSON""TEXTAREA"
defaultValue?|

Default value for this field

required?boolean

Whether this field is required (default: false)

Defaultfalse
options?array<string>|

The options of a SELECT field, for example ["Small","Large"]. Required for SELECT.

Response Body

200

application/json
  1. response
id*string

Unique custom field identifier

name*string

Custom field name

type*string

Field type: DOCUMENT or CONTACT

Value in"DOCUMENT""CONTACT"
inputType*string

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

Value in"TEXT""NUMBER""DATE""EMAIL""PHONE""URL""BOOLEAN""SELECT""JSON""TEXTAREA"
defaultValue*|

Default value for this field

required*boolean

Whether this field is required

options*array<string>|

The options of a SELECT field, for example ["Small","Large"]. Null for other input types.

createdAt*string

Date and time when custom field was created

Formatdate-time
updatedAt*string

Date and time when custom field was last updated

Formatdate-time
Example Request
curl -X POST 'https://app.sajn.se/api/v1/custom-fields' \  -H 'Content-Type: application/json' \  -d '{  "name": "Startdatum",  "type": "DOCUMENT",  "inputType": "TEXT",  "defaultValue": "2026-11-01",  "required": false,  "options": [    "Heltid"  ]}'
Example Response
{  "id": "cm4k2x9p10016abcd1234efgh",  "name": "Startdatum",  "type": "DOCUMENT",  "inputType": "TEXT",  "defaultValue": "2026-11-01",  "required": true,  "options": [    "Heltid"  ],  "createdAt": "2026-09-28T09:12:00.000Z",  "updatedAt": "2026-09-28T09:15:00.000Z"}

Was this page helpful?