v1

latestOpenAPI 3.0.12026-08-0621301.7 MB

DealFields

Update a deal field

Updates a deal field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

put/dealFields/{id}

Path parameters

idinteger required

The ID of the field

Request body

namestring

The name of the field

optionsobject[]

When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: [{"id":123,"label":"Existing Item"},{"label":"New Item"}]

add_visible_flagboolean

Whether the field is available in 'add new' modal or not (both in web and mobile app)

Response

Success

successboolean

If the response is successful or not