---
title: "Add a new product field"
method: POST
path: "/productFields"
tags: ["ProductFields"]
---

# Add a new product field

`POST /productFields`

Adds a new product field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

## Request body

- object
  - `name` string, required — The name of the field
  - `options` object[] — When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
  - `field_type` 'varchar' | 'varchar_auto' | 'text' | 'double' | 'monetary' | 'date' | 'set' | 'enum' | 'user' | 'org' | 'people' | 'phone' | 'time' | 'timerange' | 'daterange' | 'address', required — The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>

## Response `201`

Get the data for a single product field

- object
  - `success` boolean — If the response is successful or not
  - `data` object — All data for the product field
    - `name` string, required — The name of the field
    - `options` object[] — When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
    - `field_type` 'varchar' | 'varchar_auto' | 'text' | 'double' | 'monetary' | 'date' | 'set' | 'enum' | 'user' | 'org' | 'people' | 'phone' | 'time' | 'timerange' | 'daterange' | 'address', required — The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>
    - `id` integer — The ID of the product field
    - `key` string — The key of the product field
    - `order_nr` integer — The position (index) of the product field in the detail view
    - `add_time` string — The product field creation time. Format: YYYY-MM-DD HH:MM:SS
    - `update_time` string — The product field last update time. Format: YYYY-MM-DD HH:MM:SS
    - `last_updated_by_user_id` integer — The ID of the last user to update the product field
    - `created_by_user_id` integer — The ID of the user who created the product field
    - `active_flag` boolean — Whether or not the product field is currently active
    - `edit_flag` boolean — Whether or not the product field name and metadata is editable
    - `add_visible_flag` boolean — Whether or not the product field is visible in the Add Product Modal
    - `important_flag` boolean — Whether or not the product field is marked as important
    - `bulk_edit_allowed` boolean — Whether or not the product field data can be edited
    - `searchable_flag` boolean — Whether or not the product field is searchable
    - `filtering_allowed` boolean — Whether or not the product field value can be used when filtering searches
    - `sortable_flag` boolean — Whether or not the product field is sortable
    - `mandatory_flag` boolean — Whether or not the product field is mandatory when creating products

---

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