POST /custom_fields/{custom_field_gid}/enum_options/insert

Required scope: custom_fields:write

Moves a particular enum option to be either before or after another specified enum option in the custom field. Locked custom fields can only be reordered by the user who locked the field.

Servers

Path parameters

Name Type Required Description
custom_field_gid String Yes

Globally unique identifier for the custom field.

Request headers

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

Default value: "application/json"

Query parameters

Name Type Required Description
opt_pretty Boolean No

Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

opt_fields[] Array No

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

Request body fields

Name Type Required Description
data Object No
data.enum_option String Yes

The gid of the enum option to relocate.

data.before_enum_option String No

An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.

data.after_enum_option String No

An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.

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.