---
updatedAt: 2026-11-10T14:10:04.000Z
agentTools:
  projectIndex: https://docs.followupboss.com/llms.txt
---

# /dealCustomFields/:id

Update a deals custom field.

> 🚧 Require owner permissions
>
> Only the owner has access to modify deals custom fields.

> 📘 Order Weights
>
> You can create a custom sort order by setting the `orderWeight` field. For example, if you have one option with an `orderWeight` of 10000 and another of 11000, you can create a new stage with an `orderWeight` of 10500 that would be placed between them.
>
> However, once the stage has been created, the `orderWeight` for all stages will be recalculated to enforce the new ordering with gaps of 1000. In the previous example, that means the value that was at 11000 will be moved to 12000 and the new one created at 10500 becomes 11000.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.followupboss.com/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/dealCustomFields/{id}": {
      "put": {
        "summary": "/dealCustomFields/:id",
        "description": "Update a deals custom field.",
        "operationId": "dealcustomfields-id-put",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the deals custom field.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "label",
                  "type"
                ],
                "properties": {
                  "label": {
                    "type": "string",
                    "description": "The user-friendly name of the custom field (e.g., \"Anniversary\")."
                  },
                  "type": {
                    "type": "string",
                    "description": "The type of deals custom field.",
                    "enum": [
                      "text",
                      "date",
                      "number",
                      "dropdown"
                    ]
                  },
                  "choices": {
                    "type": "array",
                    "description": "Array of options related to a deals custom field of type `Dropdown`.",
                    "items": {
                      "type": "string"
                    }
                  },
                  "isRecurring": {
                    "type": "boolean",
                    "description": "Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.).",
                    "default": false
                  },
                  "hideIfEmpty": {
                    "type": "boolean",
                    "description": "Sets whether we will hide this field if it is empty.",
                    "default": false
                  },
                  "orderWeight": {
                    "type": "integer",
                    "description": "A weighted integer for the field to assign values for custom sorting.",
                    "default": 0,
                    "format": "int32"
                  },
                  "dropdownChoiceMap": {
                    "type": "array",
                    "description": "An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own.",
                    "default": [
                      null
                    ],
                    "items": {
                      "type": "integer",
                      "format": "int32"
                    }
                  },
                  "readOnly": {
                    "type": "boolean",
                    "description": "Sets whether the field is read only or not.",
                    "default": false
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "label": "Birthday",
                    "type": "date",
                    "isRecurring": false
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": 2,\n  \"label\": \"Birthday\",\n  \"name\": \"customBirthday\",\n  \"type\": \"date\",\n  \"isRecurring\": false,\n  \"orderWeight\": 1,\n  \"hideIfEmpty\": true,\n  \"readOnly\": false\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    },
                    "label": {
                      "type": "string",
                      "example": "Birthday"
                    },
                    "name": {
                      "type": "string",
                      "example": "customBirthday"
                    },
                    "type": {
                      "type": "string",
                      "example": "date"
                    },
                    "isRecurring": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "orderWeight": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "hideIfEmpty": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "readOnly": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```