v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Custom Property

Create a Custom Property

Creates a new custom property for the organization. The property type (text or list) cannot be changed after creation.

post/custom_properties

Request body

namestring required

Display name of the property.

type'text' | 'list' required

Field type. Cannot be changed after creation.

multiple_answer_allowedboolean

For list type only. Whether multiple options can be selected.

default_valuestring nullable

For text type only. Default text pre-filled on new SRs.

workspacesUUID[]

List of Workspaces that define where the Custom Property is scoped. If the array is empty, the Custom Property is available to all Workspaces.

Example request

{
  "name": "Document Type",
  "type": "list",
  "default_value": "REF-001",
  "options": [
    {
      "value": "Quote"
    }
  ],
  "workspaces": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ]
}

Response

Created

idstring uuid required

ID of the Custom Property.

namestring required

Name of the Custom Property.

type'text' | 'list' required

Type of the Custom Property.

valuestring required

Text value for text properties.

value_idsstring[] required

Array of option ids for list properties.

valuesstring[] required

Array of option values for list properties.

Example response

{
  "id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "name": "Department",
  "type": "text",
  "value": "Marketing"
}