custom-fields

Update a custom field

Updates a custom field in the studio the API key belongs to. Only the fields sent are changed, and at least one must be sent. The type of a custom field cannot be changed.

PATCH

/v1/custom-fields/{id}

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/custom-fields/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "defaultValue": "<string>",
  "description": "<string>",
  "isSearchable": true,
  "isUnique": true,
  "name": "<string>",
  "selectValues": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 123,
      "value": "<string>"
    }
  ],
  "type": "text"
}
'

{
  "createdAt": "<string>",
  "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "defaultValue": "<string>",
  "description": "<string>",
  "entityType": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isSearchable": true,
  "isUnique": true,
  "name": "<string>",
  "selectableValues": [
    {
      "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 123,
      "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ],
  "type": "text",
  "updatedAt": "<string>"
}

Path Parameters

idstringrequired

The id of the custom field to update.

Body

currencyIdstring | null

The id of the currency for currency fields. Send null to clear it.

defaultValuestring | null

The default value applied to the custom field. Send null to clear it; empty strings are rejected.

Minimum string length: 1

descriptionstring | null

A description of the custom field. Send null to clear it; empty strings are rejected.

Minimum string length: 1

isSearchableboolean

Whether this custom field can be used in searches.

isUniqueboolean

Whether each value of this custom field must be unique. Enabling it fails with 409 when existing values are already duplicated.

namestring

The display name of the custom field. Must not match an existing asset custom field, tag category or location category name in the studio.

Minimum string length: 1

selectValuesobject[]

The complete list of options for a select custom field. Items with an id update that existing option; items without an id are created as new options. Existing option ids omitted from this array are deleted together with all content stored against them. Only valid on select custom fields.

Show child attributes

typeenum<string>

The data type of the custom field. The type cannot be changed, so it must match the current type if sent.

Available options: text, select, description, date, email, number, checkbox, url, currency, signature, hyperlink

Response

The updated custom field

createdAtstringrequired

When the custom field was created, as an ISO 8601 timestamp.

currencyIdstring | nullrequired

The id of the currency for currency fields, or null otherwise.

defaultValuestring | nullrequired

The default value applied to the custom field, or null when none.

descriptionstring | nullrequired

A description of the custom field, or null when none.

entityTypestringrequired

The kind of record this custom field applies to, such as reservation.

idstringrequired

The id of the custom field.

isSearchablebooleanrequired

Whether this custom field can be used in searches.

isUniquebooleanrequired

Whether each value of this custom field must be unique.

namestringrequired

The display name of the custom field.

selectableValuesobject[]required

The options available for select custom fields.

Show child attributes

typeenum<string>required

The data type of the custom field.

Available options: text, select, description, date, email, number, checkbox, url, currency, signature, hyperlink

updatedAtstringrequired

When the custom field was last updated, as an ISO 8601 timestamp.

Still need help? Ask the team

Authorizations

Path Parameters

Body

Response