Update Merchant Custom Attribute Definition - Automate.ax

square.updateMerchantCustomAttributeDefinition updates a merchant-related custom attribute definition for a Square seller account.

Example

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

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

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

    square.updateMerchantCustomAttributeDefinition({
      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 merchant custom attribute definition. The version field must match the current version of the custom attribute definition to enable optimistic concurrency If this is not important for your application, version can be set to -1. For any other values, the request fails with a BAD_REQUEST error.
`idempotencyKey`	`string \| null`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

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

Output

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