PIpipedrive
PersonFields

Add a new person field

Changed on

Adds a new person 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>.

post/personFields

Request

  • Base URL
    https://api.pipedrive.com/v1
  • Auth
    • API key in header x-api-token
    • or OAuth 2
      Authorization code: https://oauth.pipedrive.com/oauth/authorize
      Token URL: https://oauth.pipedrive.com/oauth/token scopes: contact-fields:full, admin

Request body

namestring required

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. Example: [{"label":"New Item"}]

add_visible_flagboolean

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

field_type'address' | 'date' | 'daterange' | 'double' | 'enum' | 'monetary' | 'org' | 'people' | 'phone' | 'set' | 'text' | 'time' | 'timerange' | 'user' | 'varchar' | 'varchar_auto' | 'visible_to' required

The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>address</td><td>Address field</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>

Response

Success

successboolean

If the response is successful or not

Changes

  • cc7952f2605bRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      the security scope contact-fields:full was added to the endpoint's security scheme oauth2

    • info

      added subschema #1: Field subschema #2 to the / response property allOf list for the response status

  • 5c2800de8edbRevision changes
    • info

      endpoint added