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

Create a Custom Property

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Display name of the property.

string
enum
required

Field type. Cannot be changed after creation.

Allowed:
boolean
Defaults to false

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
length ≥ 1

For list type only. Selectable options. At least one required.

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