---
title: "Create a Custom Property"
method: POST
path: "/custom_properties"
tags: ["Custom Property"]
---

# Create a Custom Property

`POST /custom_properties`

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

## Request body

- CreateCustomProperty
  - `name` string, required — Display name of the property.
  - `type` 'text' | 'list', required — Field type. Cannot be changed after creation.
  - `multiple_answer_allowed` boolean — For list type only. Whether multiple options can be selected.
  - `default_value` string, nullable — For text type only. Default text pre-filled on new SRs.
  - `options` CustomPropertyOptionInput[] — For list type only. Selectable options. At least one required.
    - `value` string, required — Display text of the option.
    - `is_default` boolean — Whether this option is pre-selected on new SRs. Multiple defaults allowed if multiple_answer_allowed is true.
    - `position` integer — Sort order (0-based). If omitted, values are ordered as provided.
  - `workspaces` UUID[] — List of Workspaces that define where the Custom Property is scoped. If the array is empty, the Custom Property is available to all Workspaces.

## Response `201`

Created

- CustomProperty
  - `id` string, uuid, required — ID of the Custom Property.
  - `name` string, required — Name of the Custom Property.
  - `type` 'text' | 'list', required — Type of the Custom Property.
  - `value` string, required — Text value for text properties.
  - `value_ids` string[], required — Array of option ids for list properties.
  - `values` string[], required — Array of option values for list properties.

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)