--- title: "Update custom field" method: PUT path: "/custom_fields/{custom_field_id}" tags: ["Custom Fields"] --- # Update custom field `PUT /custom_fields/{custom_field_id}` This endpoint enables you to update a specific custom field of your organization by specifying its ID. You can update the **name**, **description**, **slug**, **constraints**, and **section assignment** of the custom field. However, the **type** of a custom field cannot be modified. Use the `force` parameter to apply changes that might conflict with existing business data. `PROVIDER` users can pass `org_id` to update a custom field for a managed organization. ## Path parameters - `custom_field_id` integer, required — Id of the custom field ## Query parameters - `org_id` integer ## Request body - union - CustomFieldEditTypeBool — Boolean Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — BOOLEAN - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldEditTypeText — Text Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — TEXT - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `max_len` integer — maximum lenght for TEXT field - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldEditTypeInteger — Integer Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — INTEGER - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `min` integer — minimum value for INTEGER field - `max` integer — maximum value for INTEGER field - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldEditTypeFloat — Float Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — FLOAT - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `min` number — minimum value for FLOAT field - `max` number — maximum value for FLOAT field - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldTypeEditSingleSelect — Single Select Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — SINGLE_SELECT - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `created_values` string[] — list of available values to add - `created_values_orders` integer[], nullable — The order of the created values. Array of integers where each element corresponds to the display order of the value at the same index in created_values. Orders with gaps (e.g., [5, 8, 1]) will be automatically normalized to consecutive values (e.g., [2, 3, 1]) while preserving the relative ordering. - `deleted_values` string[] — list of available values to remove - `renamed_values` object[] — list of available values to rename - `old_value` string - `new_value` string - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldTypeEditMultipleSelect — Multiple Select Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — MULTIPLE_SELECT - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `created_values` string[] — list of available values to add - `created_values_orders` integer[], nullable — The order of the created values. Array of integers where each element corresponds to the display order of the value at the same index in created_values. Orders with gaps (e.g., [5, 8, 1]) will be automatically normalized to consecutive values (e.g., [2, 3, 1]) while preserving the relative ordering. - `deleted_values` string[] — list of available values to remove - `renamed_values` object[] — list of available values to rename - `old_value` string - `new_value` string - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldTypeEditMultipleSelectImage — Multiple Select Image Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — MULTIPLE_SELECT_IMAGE - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `created_values` object[] — list of available values to add - `label` string, required — Label for the image option - `url` string, required — URL of the image option - `value` string, required — Value identifier for the option - `order` integer, nullable — Display order for the option - `deleted_values` string[] — list of available values to remove - `edited_values` object[] — list of available values to edit - `label` string, required — New label for the image option - `url` string, required — New URL for the image option - `value` string, required — New value for the image option - `old_value` string, required — Original value being edited - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section - CustomFieldTypeEditImagesUploader — Images uploader Custom Field - `name` string, required — The name of the custom field - `description` string, nullable — Description of the custom field - `type` string, required — IMAGES_UPLOADER - `slug` string, nullable — Unique identifier slug for the custom field. Cannot contain any of the following characters: `,;/\|<>` - `created_values` CustomFieldValuesImagesUploader[] — List of text fields to add - `text_field` string - `max_length` number - `deleted_values` string[] — List of text fields to delete - `edited_values` object[] — List of edited text fields - `new_value` CustomFieldValuesImagesUploader — Images uploader custom field value - `text_field` string - `max_length` number - `old_value` CustomFieldValuesImagesUploader — Images uploader custom field value - `text_field` string - `max_length` number - `force` boolean — The deletion of a custom field or the update of its metadata can have impacts on custom fields which are already set for businesses. - If `force` is set to false, updates/deletions will be performed only if they are non-destructive. If some businesses would be impacted by the update/deletion, an exception will be returned. - If `force` is set to true, destructive modification will be performed and businesses' values will be deleted accordingly. - `section_id` integer — Id of the custom field section ## Response `200` OK - object - `status` 'success' — Request status ## Other responses - `400` — New constraints are not respected for some businesses - `401` — You are not authenticated - `403` — You are not allowed to perform this action - `404` — Resource does not exist --- [API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)