POST /organizationFields

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

The name of the field

options[] Array No

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"}]

field_type String Yes

The type of the field

ValueDescription
addressAddress field
dateDate (format YYYY-MM-DD)
daterangeDate-range field (has a start date and end date value, both YYYY-MM-DD)
doubleNumeric value
enumOptions field with a single possible chosen option
monetaryMonetary field (has a numeric value and a currency value)
orgOrganization field (contains an organization ID which is stored on the same account)
peoplePerson field (contains a person ID which is stored on the same account)
phonePhone field (up to 255 numbers and/or characters)
setOptions field with a possibility of having multiple chosen options
textLong text (up to 65k characters)
timeTime field (format HH:MM:SS)
timerangeTime-range field (has a start time and end time value, both HH:MM:SS)
userUser field (contains a user ID of another Pipedrive user)
varcharText (up to 255 characters)
varchar_autoAutocomplete text (up to 255 characters)
visible_toSystem field that keeps item's visibility setting

Possible values:

  • "date"
  • "address"
  • "text"
  • "time"
  • "monetary"
  • "varchar"
  • "double"
  • "org"
  • "timerange"
  • "phone"
  • "set"
  • "enum"
  • "varchar_auto"
  • "daterange"
  • "people"
  • "visible_to"
  • "user"
add_visible_flag Boolean No

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

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.