Deal custom field labels

Sort deal custom fields

Reorder the deal custom fields as they appear in the app.

put/admin/deal_custom_field_labels/sort

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/deal_custom_field_labels/sort
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Request body

orderinteger[] required

Custom field label ids in the desired order

Example request

{
  "order": [
    4821,
    4819,
    4820
  ]
}

Response

The fields in their new order

idinteger

Unique identifier

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

field_type'dropdown' | 'multi_select' | 'forecast' | 'text' | 'date' | 'currency' | 'numeric' | 'single_association' | 'multi_association' | 'boolean'

Type of custom field

namestring

Name of the custom field

record_type'deal' | 'company' | 'person' | 'project'

The type of record that association custom fields (single_association/multi_association) link to. Cannot be changed after the custom field is created.

is_requiredboolean nullable

Whether or not this custom field must be filled in to save it's associated record

Example response

[
  {
    "id": 4821,
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "field_type": "dropdown",
    "name": "Contract term",
    "record_type": "deal"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.