Pipedrive API

Getting access, Developing, Testing

Back to Pipedrive

Add a new product field

Adds a new product field. For more information, see the tutorial for adding a new custom field.

Input

type: object properties: data: type: object required: - name - field_type properties: name: type: string description: The name of the field options: type: array description: >- 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"}]` items: type: object field_type: type: string enum: - varchar - varchar_auto - text - double - monetary - date - set - enum - user - org - people - phone - time - timerange - daterange - address description: >- 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 (autocompleted by Google Maps)</dd></table>

Output

title: getProductFieldResponse200 type: object properties: success: type: boolean description: If the response is successful or not data: description: All data for the product field title: productField type: object required: - name - field_type properties: name: type: string description: The name of the field options: type: array description: >- 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"}]` items: type: object field_type: type: string enum: - varchar - varchar_auto - text - double - monetary - date - set - enum - user - org - people - phone - time - timerange - daterange - address description: >- 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 (autocompleted by Google Maps)</dd></table> id: type: integer description: The ID of the product field key: type: string description: The key of the product field order_nr: type: integer description: The position (index) of the product field in the detail view add_time: type: string description: 'The product field creation time. Format: YYYY-MM-DD HH:MM:SS' update_time: type: string description: 'The product field last update time. Format: YYYY-MM-DD HH:MM:SS' last_updated_by_user_id: type: integer description: The ID of the last user to update the product field active_flag: type: boolean description: Whether or not the product field is currently active edit_flag: type: boolean description: Whether or not the product field name and metadata is editable add_visible_flag: type: boolean description: Whether or not the product field is visible in the Add Product Modal important_flag: type: boolean description: Whether or not the product field is marked as important bulk_edit_allowed: type: boolean description: Whether or not the product field data can be edited searchable_flag: type: boolean description: Whether or not the product field is searchable filtering_allowed: type: boolean description: >- Whether or not the product field value can be used when filtering searches sortable_flag: type: boolean description: Whether or not the product field is sortable mandatory_flag: type: boolean description: Whether or not the product field is mandatory when creating products