Update Location Custom Attribute Definition - Automate.ax

square.updateLocationCustomAttributeDefinition updates a location-related custom attribute definition for a Square seller account.

Example

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

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

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

    square.updateLocationCustomAttributeDefinition({
      key: "key",
      customAttributeDefinition: {
        description: "Update the description as desired.",
        visibility: "VISIBILITY_READ_ONLY",
      },
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_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. This endpoint supports sparse updates, so only new or changed fields need to be included in the request. 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 Update a location custom attribute definition. To enable optimistic concurrency control, specify the current version of the custom attribute definition. If this is not important for your application, `version` can be set to -1.
`idempotencyKey`	`string \| null`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

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

Output

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