Create Booking Custom Attribute Definition - Automate.ax

square.createBookingCustomAttributeDefinition creates a bookings custom attribute definition.

Example

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

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

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

    square.createBookingCustomAttributeDefinition({
      customAttributeDefinition: {},
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires APPOINTMENTS_WRITE.

Field	Type	Required	Default	Description
`customAttributeDefinition`	`Square.CustomAttributeDefinition`	Yes	—	The custom attribute definition to create, with the following fields: - `key` - `name`. If provided, `name` must be unique (case-sensitive) across all visible booking-related custom attribute definitions for the seller. - `description` - `visibility`. Note that all custom attributes are visible in exported booking data, including those set to `VISIBILITY_HIDDEN`. - `schema`. With the exception of the `Selection` data type, the `schema` is specified as a simple URL to the JSON schema definition hosted on the Square CDN. For more information, see Specifying the schema.
`idempotencyKey`	`string`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

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

Output

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