Update Booking Custom Attribute Definition - Automate.ax

square.updateBookingCustomAttributeDefinition updates a bookings custom attribute definition.

Example

automations/square-update-booking-custom-attribute-definition.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation(
  "Update Square Booking Custom Attribute Definition",
  () => {
    onDashboardRun({
      title: "Update Square Booking Custom Attribute Definition",
    })

    square.updateBookingCustomAttributeDefinition({
      key: "key",
      customAttributeDefinition: {},
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires APPOINTMENTS_WRITE.

Field	Type	Required	Default	Description
`key`	`string`	Yes	—	The key of the custom attribute definition to update.
`customAttributeDefinition`	`Square.CustomAttributeDefinition`	Yes	—	The custom attribute definition that contains the fields to update. Only the following fields can be updated: - `name` - `description` - `visibility` - `schema` for a `Selection` data type. Only changes to the named options or the maximum number of allowed selections are supported. For more information, see Updatable definition fields. To enable optimistic concurrency control, include the optional `version` field and specify the current version of the custom attribute definition.
`idempotencyKey`	`string \| null`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Use the official UpdateBookingCustomAttributeDefinition reference for provider field semantics and limits.

Output

Returns the official Square.UpdateBookingCustomAttributeDefinitionResponse response as a codec-safe object. Square integer money amounts remain bigint values.