Upsert Merchant Custom Attribute - Automate.ax

square.upsertMerchantCustomAttribute creates or updates a custom attribute for a merchant.

Example

automations/square-upsert-merchant-custom-attribute.automation.ts

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

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

  square.upsertMerchantCustomAttribute({
    merchantId: "merchant_id",
    key: "key",
    customAttribute: {
      value: "Ultimate Sneaker Store",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_WRITE.

Field	Type	Required	Default	Description
`merchantId`	`string`	Yes	—	The ID of the target merchant.
`key`	`string`	Yes	—	The key of the custom attribute to create or update. This key must match the `key` of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
`customAttribute`	`Square.CustomAttribute`	Yes	—	The custom attribute to create or update, with the following fields: - `value`. This value must conform to the `schema` specified by the definition. For more information, see Supported data types. - 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 UpsertMerchantCustomAttribute reference for provider field semantics and limits.

Output

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