Create Customer Custom Attribute Definition - Automate.ax

square.createCustomerCustomAttributeDefinition creates a customer-related custom attribute definition for a Square seller account.

Example

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

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

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

    square.createCustomerCustomAttributeDefinition({
      customAttributeDefinition: {
        key: "favoritemovie",
        schema: {
          $ref: "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String",
        },
        name: "Favorite Movie",
        description: "The favorite movie of the customer.",
        visibility: "VISIBILITY_HIDDEN",
      },
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires CUSTOMERS_WRITE.

Field	Type	Required	Default	Description
`customAttributeDefinition`	`Square.CustomAttributeDefinition`	Yes	—	The custom attribute definition to create. Note the following: - 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, including supported values and constraints, see Specifying the schema. - If provided, `name` must be unique (case-sensitive) across all visible customer-related custom attribute definitions for the seller. - All custom attributes are visible in exported customer data, including those set to `VISIBILITY_HIDDEN`.
`idempotencyKey`	`string`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

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

Output

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