YOyousign
Custom Property

Update a Custom Property

Changed on

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}

Request

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

Unique identifier of the custom property.

namestring required

Display name of the property.

type'text' | 'list' required

Field type.

requiredboolean

Whether users must fill this property before sending the SR via the application (not enforced via API).

multiple_answer_allowedboolean nullable

For list type only — whether multiple options can be selected. Null for text type.

workspace_idsUUID[] nullable

List of workspace IDs where this property is applicable. Null means org-wide.

default_valuestring nullable

For text type only — default text pre-filled on new signature requests. Null for list type.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

{
  "workspace_ids": [
    "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
  ]
}

Changes

  • d70860094a83Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status