Update a custom field
Partial update: only the fields sent change.
Path Parameters
- Type: stringFormat: uuididrequired
Custom field id.
Body·
required
application/json
Any subset of writable fields. At least one is required. Unknown or read-only fields are rejected.
- Type: string | nulldescription
- Type: string | nullentity
The table the field is on, e.g. gigs or venues. Fixed once created.
- Type: string | nullenumfield
_type Fixed once created; to change a field’s type, retire it and add a new one.
values- rich
_text - number
- currency
- date
- time
- checkbox
- select
- multi
_select
- rich
- Type: string | nullkey
The column name: lowercase, starting with x_. Fixed once created.
- Type: string | nulllabel
- Type: array of string | nulloptions
The allowed values of a select or multi_select field.
- Type: number | nullorder
- Type: string | nullrelation
The table a relation field points at. Fixed once created.
- Type: booleanrequired
New records must supply a value. Checked by the API, not the database.
- Type: "active" or "retired" or nullenumstatus
A retired field is hidden from the API and the app; its column and data stay.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for patch/custom-fields/{id}
curl https://api.weddingoperatingsystems.com/api/v1/custom-fields/123e4567-e89b-12d3-a456-426614174000 \
--request PATCH \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"label": null,
"entity": null,
"key": null,
"field_type": "rich_text",
"options": [
""
],
"relation": null,
"required": true,
"description": null,
"order": null,
"status": "active"
}'
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"entity": null,
"key": null,
"field_type": "rich_text",
"options": [
"string"
],
"relation": null,
"required": true,
"description": null,
"order": null,
"status": "active",
"created_time": "2026-10-05T17:38:27.325Z",
"last_edited_time": "2026-10-05T17:38:27.325Z"
}
}