PUT /personFields/{id}

Updates a person field. For more information, see the tutorial for updating custom fields' values.

Servers

Path parameters

Name Type Required Description
id Integer Yes

The ID of the field

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 No

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. 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_flag Boolean No

Whether the field is available in 'add new' modal or not (both in 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.