Skip to main content

Add/Update values in company field

info

This method is available only for fields with the following types: Dropdown list (select), Related fields (hierarchy), Multi-button (multi_button)

POST /organizations/custom_fields/:field_id/options/


URL

https://system_domain/api/v2/organizations/custom_fields/123/options/


Parameters

PATH-parameters

ParameterTypeRequiredDescription
field_idnumberYesID of the custom field

Request body parameters (JSON)

ParameterTypeRequiredDescription
optionsarrayYesArray of values

Request body examples (JSON)

{
"options": [ // Adding a new value
{
"name": {
"en": "New option",
"ru": "Новая опция"
}
}
]
}

{
"options": [ // Updating an existing value
{
"id": 11016, // ID of the value to update
"name": {
"en": "Updated option",
"ru": "Обновлённое значение"
}
}
]
}

{
"options": [ // Adding a new value for related fields at a specific level
{
"pid": 4588, // ID of the parent value
"name": {
"en": "New option",
"ru": "Новая опция"
}
}
]
}

Responses

Response examples

Response example
{
"data": [ // Response to adding a new value
{
"id": 11016,
"name": {
"en": "New option",
"ru": "Новая опция"
}
}
]
}

{
"data": [ // Response to updating an existing value
{
"id": 11016,
"name": {
"en": "Updated option",
"ru": "Обновлённое значение"
}
}
]
}

{
"data": [ // Response to adding a new value for related fields at a specific level
{
"id": 11016,
"name": {
"en": "New option",
"ru": "Новая опция"
}
}
]
}