---
title: "Sort deal custom fields"
method: PUT
path: "/admin/deal_custom_field_labels/sort"
tags: ["Deal custom field labels"]
---

# Sort deal custom fields

`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`

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

## Request body

- object
  - `order` integer[], required: Custom field label ids in the desired order

## Response `200`

The fields in their new order

- CustomFieldLabelAll[]
  - `id` integer: Unique identifier
  - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
  - `updated_at` string: 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
  - `name` string: 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_required` boolean, nullable: Whether or not this custom field must be filled in to save it's associated record

## Other responses

- `403`: The credentials are valid but this user may not perform the action (permissions, a read-only token, or API access switched off).
- `422`: The list of ids did not match the account's records; no body.

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)