API Reference
Status PageRoadmapTestimoniesShare feedback
  1. electronic signature
  2. Custom Property

Update a Custom Property

patch
https://api-sandbox.yousign.app/v3/custom_properties/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Custom Property Id

Body Params
string
length between 1 and 255

Display name of the property.

string
enum

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

Allowed:
boolean

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

string | null

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

options
array of objects

For list type only. Send the full array to replace all options.

  • Include id for existing options to preserve them (rename/reorder).
  • Omit id for new options.
  • Options not present in the array are removed.
options
workspaces
array of objects, unique
length ≥ 0

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

workspaces
Responses

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago