Delete a custom field definition

Delete a custom field definition.

Warning: This will remove all values associated with this field from all documents/contacts.

DELETE /api/v1/custom-fields/{id}

Delete a custom field definition

cURL

curl --request DELETE \
  --url https://app.sajn.se/api/v1/custom-fields/{id} \
  --header 'authorization: <authorization>'

200

{
  "id": "<string>",
  "name": "<string>",
  "defaultValue": "<string>",
  "required": true,
  "options": "<string>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>"
}

Headers

authorization · string · required

Bearer token for API authentication

Path Parameters

id · string · required

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 · any · required

Date and time when custom field was created

updatedAt · any · required

Date and time when custom field was last updated