Skip to content

feat: add options field docs in create property API #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danciaclara merged 1 commit into from
Nov 29, 2025
Merged

feat: add options field docs in create property API #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions api-reference/issue-types/properties/add-property.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,15 @@ Default value(s) for the property.
<ParamField body="is_required" type="boolean">Whether this property is required when creating work items.</ParamField>
<ParamField body="is_active" type="boolean">Whether this property is currently active.</ParamField>
<ParamField body="is_multi" type="boolean">Whether this property allows multiple values.</ParamField>
<ParamField body="options" type="object[]">
Array of option objects for OPTION type properties. This field can be used while creating a property with type OPTION to set options on the custom property during creation itself. Each option object can contain:
- `name` (string): Name of the option
- `description` (string): Description of the option
- `is_active` (boolean): Whether the option is active
- `sort_order` (number): Sort order for the option
- `parent` (string): Parent option ID for hierarchical options
- `is_default` (boolean): Whether this is the default option
- `logo_props` (object): Logo properties for the option

To add or update options on an OPTION property after creation, you can use the APIs from [`issue-types/options/add-dropdown-options`](/api-reference/issue-types/options/add-dropdown-options).
</ParamField>
18 changes: 16 additions & 2 deletions api-reference/issue-types/values/add-property-values.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ The unique identifier for the work item.

## Body parameters

<ParamField body="values" type="object[]" required>
<ParamField body="value" type="string" required></ParamField>
<ParamField body="value" type="string | boolean | number | string[]" required>
The value type depends on the property type:
- TEXT/URL/EMAIL/FILE: string
- DATETIME: string (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
- DECIMAL: number (int or float)
- BOOLEAN: boolean (true/false)
- OPTION/RELATION (single): string (UUID)
- OPTION/RELATION (multi, when is_multi=True): list of strings (UUIDs) or single string

For multi-value properties (is_multi=True):
- Accept either a single UUID string or a list of UUID strings
- Multiple records are created
- Response will be a list of values

For single-value properties:
- Only one value is allowed per work item/property combination
</ParamField>
Loading