arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/CreateCustomerAttributeDefinition.json

{
  "name": "CreateCustomerAttributeDefinition",
  "fully_qualified_name": "SquareupApi.CreateCustomerAttributeDefinition@2.0.0",
  "description": "Create a custom attribute for customer profiles.\n\nThis tool creates a custom attribute definition that can be associated with customer profiles for a Square seller account. Use it to specify the key, visibility, schema, and other properties for the custom attribute.",
  "toolkit": {
    "name": "ArcadeSquareupApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "custom_attribute_key",
        "required": false,
        "description": "Unique identifier for the custom attribute definition, either a simple or qualified key. Up to 60 characters, including alphanumeric, periods (.), underscores (_), and hyphens (-).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.key"
      },
      {
        "name": "custom_attribute_schema",
        "required": false,
        "description": "The JSON schema defining the data type for the custom attribute. This is required when creating a definition.",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.schema"
      },
      {
        "name": "attribute_definition_name",
        "required": false,
        "description": "The unique name of the custom attribute definition for both API and UI purposes. Required if visibility is set to 'VISIBILITY_READ_ONLY' or 'VISIBILITY_READ_WRITE_VALUES'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.name"
      },
      {
        "name": "customer_attribute_description",
        "required": false,
        "description": "A description for the custom attribute definition, required if visibility is set to 'VISIBILITY_READ_ONLY' or 'VISIBILITY_READ_WRITE_VALUES'. This serves as a seller-oriented tooltip.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.description"
      },
      {
        "name": "custom_attribute_visibility",
        "required": false,
        "description": "Specify the level of permission required to view the custom attribute definition. Options include 'VISIBILITY_HIDDEN', 'VISIBILITY_READ_ONLY', and 'VISIBILITY_READ_WRITE_VALUES'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "VISIBILITY_HIDDEN",
            "VISIBILITY_READ_ONLY",
            "VISIBILITY_READ_WRITE_VALUES"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.visibility"
      },
      {
        "name": "current_custom_attribute_version",
        "required": false,
        "description": "The current version of the custom attribute definition. Incremental value used for optimistic concurrency control. Must be the latest version on writes to avoid rejection of stale updates.",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.version"
      },
      {
        "name": "timestamp_updated_at",
        "required": false,
        "description": "Timestamp indicating when the custom attribute definition was created or updated, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.updated_at"
      },
      {
        "name": "created_at_timestamp",
        "required": false,
        "description": "The timestamp indicating when the custom attribute definition was created, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "custom_attribute_definition.created_at"
      },
      {
        "name": "idempotency_key",
        "required": false,
        "description": "A unique identifier for the request to prevent duplicate executions in case of retries. This is used for ensuring idempotency.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "idempotency_key"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'CreateCustomerCustomAttributeDefinition'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-squareup",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": {
        "scopes": [
          "CUSTOMERS_WRITE"
        ]
      }
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the squareup API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://connect.squareup.com/v2/customers/custom-attribute-definitions",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "custom_attribute_definition.key",
        "tool_parameter_name": "custom_attribute_key",
        "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The identifier\nof the custom attribute definition and its corresponding custom attributes. This value\ncan be a simple key, which is the key that is provided when the custom attribute definition\nis created, or a qualified key, if the requesting\napplication is not the definition owner. The qualified key consists of the application ID\nof the custom attribute definition owner\nfollowed by the simple key that was provided when the definition was created. It has the\nformat application_id:simple key.\n\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\nunderscores (_), and hyphens (-).\n\nThis field can not be changed\nafter the custom attribute definition is created. This field is required when creating\na definition and must be unique per application, seller, and resource type."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.schema",
        "tool_parameter_name": "custom_attribute_schema",
        "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.",
        "value_schema": {
          "val_type": "json",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.name",
        "tool_parameter_name": "attribute_definition_name",
        "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The name of the custom attribute definition for API and seller-facing UI purposes. The name must\nbe unique within the seller and application pair. This field is required if the\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.description",
        "tool_parameter_name": "customer_attribute_description",
        "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Seller-oriented description of the custom attribute definition, including any constraints\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.visibility",
        "tool_parameter_name": "custom_attribute_visibility",
        "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "VISIBILITY_HIDDEN",
            "VISIBILITY_READ_ONLY",
            "VISIBILITY_READ_WRITE_VALUES"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "The level of permission that a seller or other applications requires to\nview this custom attribute definition.\nThe `Visibility` field controls who can read and write the custom attribute values\nand custom attribute definition."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.version",
        "tool_parameter_name": "current_custom_attribute_version",
        "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).",
        "value_schema": {
          "val_type": "integer",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Read only. The current version of the custom attribute definition.\nThe value is incremented each time the custom attribute definition is updated.\nWhen updating a custom attribute definition, you can provide this field\nand specify the current version of the custom attribute definition to enable\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\n\nOn writes, this field must be set to the latest version. Stale writes are rejected.\n\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview)."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.updated_at",
        "tool_parameter_name": "timestamp_updated_at",
        "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp that indicates when the custom attribute definition was created or most recently updated,\nin RFC 3339 format."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "custom_attribute_definition.created_at",
        "tool_parameter_name": "created_at_timestamp",
        "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "idempotency_key",
        "tool_parameter_name": "idempotency_key",
        "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A unique identifier for this request, used to ensure idempotency. For more information,\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency)."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": "{\n  \"required\": true,\n  \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"description\": \"Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) request.\",\n        \"x-release-status\": \"PUBLIC\",\n        \"required\": [\n          \"custom_attribute_definition\"\n        ],\n        \"properties\": {\n          \"custom_attribute_definition\": {\n            \"type\": \"object\",\n            \"description\": \"Represents a definition for custom attribute values. A custom attribute definition\\nspecifies the key, visibility, schema, and other properties for a custom attribute.\",\n            \"x-release-status\": \"PUBLIC\",\n            \"properties\": {\n              \"key\": {\n                \"type\": \"string\",\n                \"description\": \"The identifier\\nof the custom attribute definition and its corresponding custom attributes. This value\\ncan be a simple key, which is the key that is provided when the custom attribute definition\\nis created, or a qualified key, if the requesting\\napplication is not the definition owner. The qualified key consists of the application ID\\nof the custom attribute definition owner\\nfollowed by the simple key that was provided when the definition was created. It has the\\nformat application_id:simple key.\\n\\nThe value for a simple key can contain up to 60 alphanumeric characters, periods (.),\\nunderscores (_), and hyphens (-).\\n\\nThis field can not be changed\\nafter the custom attribute definition is created. This field is required when creating\\na definition and must be unique per application, seller, and resource type.\",\n                \"minLength\": 1,\n                \"pattern\": \"^([a-zA-Z0-9\\\\._-]+:)?[a-zA-Z0-9\\\\._-]{1,60}$\",\n                \"nullable\": true\n              },\n              \"schema\": {\n                \"type\": \"object\",\n                \"description\": \"The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,\\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.\",\n                \"nullable\": true\n              },\n              \"name\": {\n                \"type\": \"string\",\n                \"description\": \"The name of the custom attribute definition for API and seller-facing UI purposes. The name must\\nbe unique within the seller and application pair. This field is required if the\\n`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\",\n                \"maxLength\": 255,\n                \"nullable\": true\n              },\n              \"description\": {\n                \"type\": \"string\",\n                \"description\": \"Seller-oriented description of the custom attribute definition, including any constraints\\nthat the seller should observe. May be displayed as a tooltip in Square UIs. This field is\\nrequired if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\",\n                \"maxLength\": 255,\n                \"nullable\": true\n              },\n              \"visibility\": {\n                \"type\": \"string\",\n                \"enum\": [\n                  \"VISIBILITY_HIDDEN\",\n                  \"VISIBILITY_READ_ONLY\",\n                  \"VISIBILITY_READ_WRITE_VALUES\"\n                ],\n                \"x-enum-elements\": [\n                  {\n                    \"name\": \"VISIBILITY_HIDDEN\",\n                    \"description\": \"The custom attribute definition and values are hidden from the seller (except on export\\nof all seller data) and other developers.\"\n                  },\n                  {\n                    \"name\": \"VISIBILITY_READ_ONLY\",\n                    \"description\": \"The seller and other developers can read the custom attribute definition and values\\non resources.\"\n                  },\n                  {\n                    \"name\": \"VISIBILITY_READ_WRITE_VALUES\",\n                    \"description\": \"The seller and other developers can read the custom attribute definition,\\nand can read and write values on resources. A custom attribute definition\\ncan only be edited or deleted by the application that created it.\"\n                  }\n                ],\n                \"description\": \"The level of permission that a seller or other applications requires to\\nview this custom attribute definition.\\nThe `Visibility` field controls who can read and write the custom attribute values\\nand custom attribute definition.\",\n                \"x-release-status\": \"PUBLIC\"\n              },\n              \"version\": {\n                \"type\": \"integer\",\n                \"description\": \"Read only. The current version of the custom attribute definition.\\nThe value is incremented each time the custom attribute definition is updated.\\nWhen updating a custom attribute definition, you can provide this field\\nand specify the current version of the custom attribute definition to enable\\n[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).\\n\\nOn writes, this field must be set to the latest version. Stale writes are rejected.\\n\\nThis field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,\\nsee [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).\"\n              },\n              \"updated_at\": {\n                \"type\": \"string\",\n                \"description\": \"The timestamp that indicates when the custom attribute definition was created or most recently updated,\\nin RFC 3339 format.\",\n                \"readOnly\": true\n              },\n              \"created_at\": {\n                \"type\": \"string\",\n                \"description\": \"The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format.\",\n                \"readOnly\": true\n              }\n            }\n          },\n          \"idempotency_key\": {\n            \"type\": \"string\",\n            \"description\": \"A unique identifier for this request, used to ensure idempotency. For more information,\\nsee [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).\",\n            \"maxLength\": 45\n          }\n        },\n        \"example\": {\n          \"custom_attribute_definition\": {\n            \"description\": \"The favorite movie of the customer.\",\n            \"key\": \"favoritemovie\",\n            \"name\": \"Favorite Movie\",\n            \"schema\": {\n              \"$ref\": \"https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String\"\n            },\n            \"visibility\": \"VISIBILITY_HIDDEN\"\n          }\n        }\n      }\n    }\n  }\n}",
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}