Back to PipedriveAdd a new organization field
Input
type: object
properties:
data:
title: createFieldRequest
type: object
required:
- field_type
- name
properties:
name:
type: string
description: The name of the field
options:
type: string
description: >-
When `field_type` is either set or enum, possible options must be
supplied as a JSON-encoded sequential array of objects. Example:
`[{"label":"New Item"}]`
add_visible_flag:
type: boolean
enum:
- true
- false
default: true
description: >-
Whether the field is available in the 'add new' modal or not (both in
the web and mobile app)
field_type:
type: string
enum:
- address
- date
- daterange
- double
- enum
- monetary
- org
- people
- phone
- set
- text
- time
- timerange
- user
- varchar
- varchar_auto
- visible_to
description: >-
The type of the
field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`address`</td><td>Address
field (has multiple subfields, autocompleted by Google
Maps)</td></tr><tr><td>`date`</td><td>Date (format
YYYY-MM-DD)</td></tr><tr><td>`daterange`</td><td>Date-range field (has
a start date and end date value, both
YYYY-MM-DD)</td></tr><tr><td>`double`</td><td>Numeric
value</td></tr><tr><td>`enum`</td><td>Options field with a single
possible chosen
option</td></tr><tr></tr><tr><td>`monetary`</td><td>Monetary field
(has a numeric value and a currency
value)</td></tr><tr><td>`org`</td><td>Organization field (contains an
organization ID which is stored on the same
account)</td></tr><tr><td>`people`</td><td>Person field (contains a
person ID which is stored on the same
account)</td></tr><tr><td>`phone`</td><td>Phone field (up to 255
numbers and/or characters)</td></tr><tr><td>`set`</td><td>Options
field with a possibility of having multiple chosen
options</td></tr><tr><td>`text`</td><td>Long text (up to 65k
characters)</td></tr><tr><td>`time`</td><td>Time field (format
HH:MM:SS)</td></tr><tr><td>`timerange`</td><td>Time-range field (has a
start time and end time value, both
HH:MM:SS)</td></tr><tr><td>`user`</td><td>User field (contains a user
ID of another Pipedrive user)</td></tr><tr><td>`varchar`</td><td>Text
(up to 255
characters)</td></tr><tr><td>`varchar_auto`</td><td>Autocomplete text
(up to 255 characters)</td></tr><tr><td>`visible_to`</td><td>System
field that keeps item's visibility setting</td></tr></table>
Output
title: fieldResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: object
properties:
id:
type: integer
description: The ID of the field. Value is `null` in case of subfields.
key:
type: string
description: >-
The key of the field. For custom fields this is generated upon
creation.
name:
type: string
description: The name of the field
order_nr:
type: integer
description: The order number of the field
field_type:
type: string
enum:
- address
- date
- daterange
- double
- enum
- monetary
- org
- people
- phone
- set
- text
- time
- timerange
- user
- varchar
- varchar_auto
- visible_to
description: >-
The type of the
field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`address`</td><td>Address
field (has multiple subfields, autocompleted by Google
Maps)</td></tr><tr><td>`date`</td><td>Date (format
YYYY-MM-DD)</td></tr><tr><td>`daterange`</td><td>Date-range field (has
a start date and end date value, both
YYYY-MM-DD)</td></tr><tr><td>`double`</td><td>Numeric
value</td></tr><tr><td>`enum`</td><td>Options field with a single
possible chosen
option</td></tr><tr></tr><tr><td>`monetary`</td><td>Monetary field
(has a numeric value and a currency
value)</td></tr><tr><td>`org`</td><td>Organization field (contains an
organization ID which is stored on the same
account)</td></tr><tr><td>`people`</td><td>Person field (contains a
person ID which is stored on the same
account)</td></tr><tr><td>`phone`</td><td>Phone field (up to 255
numbers and/or characters)</td></tr><tr><td>`set`</td><td>Options
field with a possibility of having multiple chosen
options</td></tr><tr><td>`text`</td><td>Long text (up to 65k
characters)</td></tr><tr><td>`time`</td><td>Time field (format
HH:MM:SS)</td></tr><tr><td>`timerange`</td><td>Time-range field (has a
start time and end time value, both
HH:MM:SS)</td></tr><tr><td>`user`</td><td>User field (contains a user
ID of another Pipedrive user)</td></tr><tr><td>`varchar`</td><td>Text
(up to 255
characters)</td></tr><tr><td>`varchar_auto`</td><td>Autocomplete text
(up to 255 characters)</td></tr><tr><td>`visible_to`</td><td>System
field that keeps item's visibility setting</td></tr></table>
add_time:
type: string
format: datetime
description: The creation time of the field
update_time:
type: string
format: datetime
description: The update time of the field
last_updated_by_user_id:
type: integer
description: >-
The ID of the user who created or most recently updated the field,
only applicable for custom fields
active_flag:
type: boolean
description: The active flag of the field
edit_flag:
type: boolean
description: The edit flag of the field
index_visible_flag:
type: boolean
description: Not used
details_visible_flag:
type: boolean
description: Not used
add_visible_flag:
type: boolean
description: Not used
important_flag:
type: boolean
description: Not used
bulk_edit_allowed:
type: boolean
description: Whether or not the field of an item can be edited in bulk
searchable_flag:
type: boolean
description: Whether or not items can be searched by this field
filtering_allowed:
type: boolean
description: Whether or not items can be filtered by this field
sortable_flag:
type: boolean
description: Whether or not items can be sorted by this field
mandatory_flag:
type: boolean
description: Whether or not the field is mandatory
options:
type: array
nullable: true
description: >-
The options of the field. When there are no options, `null` is
returned.
items:
type: object
options_deleted:
type: array
description: >-
The deleted options of the field. Only present when there is at least
1 deleted option.
items:
type: object
is_subfield:
type: boolean
description: >-
Whether or not the field is a subfield of another field. Only present
if field is subfield.
subfields:
type: array
description: The subfields of the field. Only present when the field has subfields.
items:
type: object