Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Custom Property

Update a Custom Property

Updates a given custom property. Any parameters not provided are left unchanged. The property type cannot be changed after creation. For list properties, the options array must be sent in full to replace all options.

patch/custom_properties/{customPropertyId}

Path parameters

customPropertyIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Custom Property Id

Request body

namestring

Display name of the property.

type'text' | 'list'

Cannot be changed after creation. If provided and different from current type, request is rejected with 400.

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": "Contract Type",
  "options": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "value": "Sales Quote"
    }
  ],
  "workspaces": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ]
}

Response

OK

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"
}