Upsert Location Custom Attribute - Automate.ax

square.upsertLocationCustomAttribute creates or updates a custom attribute for a location.

Example

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

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

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

  square.upsertLocationCustomAttribute({
    locationId: "location_id",
    key: "key",
    customAttribute: {
      value: "hot cocoa",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires MERCHANT_PROFILE_WRITE.

Field	Type	Required	Default	Description
`locationId`	`string`	Yes	—	The ID of the target location.
`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. - `version`. To enable optimistic concurrency control for an update operation, include the current version of the custom attribute. 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 UpsertLocationCustomAttribute reference for provider field semantics and limits.

Output

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