---
title: "Create custom fields"
method: POST
path: "/custom_fields"
tags: ["Custom Fields"]
---

# Create custom fields

`POST /custom_fields`

This endpoint enables you to create custom fields for your organization. You can specify the field name, description, slug, type-specific constraints, order, and optionally assign it to a section. `PROVIDER` users can pass `org_id` to create custom fields for a managed organization.

## Query parameters

- `org_id` integer

## Request body

- union
  - CustomFieldBool — 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: `,;/\|<>`
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldText — 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
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldInteger — 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
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldFloat — 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
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldSingleSelect — 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: `,;/\|<>`
    - `possible_values` string[], required — list of available values
    - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_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.
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldMultipleSelect — 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: `,;/\|<>`
    - `possible_values` string[], required — list of available values
    - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_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.
    - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldMultipleSelectImage — 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: `,;/\|<>`
    - `possible_values` string[], required — List of available values. Each element corresponds to one of possible_images_urls and possible_images_labels. Hence, the 3 lists shall have the same size.
    - `possible_images_urls` string[], required — List of available urls
    - `possible_images_labels` string[], required — List of available labels. Can be set to null but shall always have the same number of elements as possible_values and possible_images_urls.
    - `possible_orders` integer[], nullable — The order of the possible values. Array of integers where each element corresponds to the display order of the value at the same index in possible_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.
    - `max_selected_values` integer, nullable — Maximum number of values that can be selected for multiple select fields
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - CustomFieldImagesUploader — 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: `,;/\|<>`
    - `text_fields` object[], required — Configuration for text type Custom Fields
      - `text_field` string, required — Name of the text field
      - `max_length` integer, nullable — Maximum length for the text field
    - `order` integer — Describes where the custom field is displayed on the Business Edit view of the Partoo App. If the custom field is within a section, **order** specifies its position within the custom field section.
    - `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
  - `custom_field_id` integer — Id of the custom field

## Other responses

- `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)