reservations

Create a reservation custom field

Creates a custom field for reservations in the studio the API key belongs to. Select fields accept their options in selectValues.

POST

/v1/reservations/custom-fields

curl --request POST \
  --url https://api.beamdynamics.io/v1/reservations/custom-fields \
  --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": [
    {
      "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>"
}

Authorizations

beam-api-keystringheaderrequired

Body

currencyIdstring | null

The id of the currency for currency fields. Send null for none.

defaultValuestring | null

The default value applied to the custom field. Send null for none.

descriptionstring | null

A description of the custom field. Send null for none.

isSearchableboolean

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. Must not match an existing asset custom field, tag category or location category name in the studio.

Minimum string length: 1

selectValuesobject[]

The options for select custom fields, each with its label (value) and position (order).

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

Response

The created reservation 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