Update a custom field

Server URLloading...

PATCH

/custom-fields/{id}

Send

Authorization

Header

Body

Updates a custom field. Only the attributes you send are changed (partial update / merge semantics); omitted attributes keep their current values.

type and entity are fixed once the field is created and are ignored if supplied.

For select fields, options is treated as the desired full set. Each entry is an object with a value: include an id (an opt_-prefixed option id) to rename that existing option, omit the id to create a new option, and any existing option absent from the payload is removed — it is no longer offered, but values already recorded against it are preserved. An id that belongs to a different field is rejected. Supplying options on a non-select field is rejected, as is an empty desired set that would leave a select field with no options.

Path Parameters

Header Parameters

Response Body

curl -X PATCH "https://example.com/custom-fields/string" \  -H "Easol-API-Version: 2026-11-01" \  -H "Content-Type: application/json" \  -d '{}'

{
  "object": "custom_field",
  "id": "fld_aBcDeFgHiJ",
  "name": "string",
  "label": "string",
  "hint": "string",
  "type": "text",
  "entity": "guest",
  "options": [
    {
      "id": "string",
      "value": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}