Square CustomerCustomAttributes API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Customer Custom Attributes API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: CustomerCustomAttributes
paths:
  /v2/customers/custom-attribute-definitions:
    get:
      tags:
      - CustomerCustomAttributes
      summary: Square List Customer Custom Attribute Definitions
      operationId: ListCustomerCustomAttributeDefinitions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.


        When all response pages are retrieved, the results include all custom attribute definitions

        that are visible to the requesting application, including those that are created by other

        applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that

        seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_READ
      parameters:
      - name: limit
        description: 'The maximum number of results to return in a single paged response. This limit is advisory.

          The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.

          The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: 'The cursor returned in the paged response from the previous call to this endpoint.

          Provide this cursor to retrieve the next page of results for your original request.

          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerCustomAttributeDefinitionsResponse'
    post:
      tags:
      - CustomerCustomAttributes
      summary: Square Create Customer Custom Attribute Definition
      operationId: CreateCustomerCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.

        Use this endpoint to define a custom attribute that can be associated with customer profiles.


        A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties

        for a custom attribute. After the definition is created, you can call

        [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or

        [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)

        to set the custom attribute for customer profiles in the seller''s Customer Directory.


        Sellers can view all custom attributes in exported customer data, including those set to

        `VISIBILITY_HIDDEN`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerCustomAttributeDefinitionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerCustomAttributeDefinitionResponse'
  /v2/customers/custom-attribute-definitions/{key}:
    delete:
      tags:
      - CustomerCustomAttributes
      summary: Square Delete Customer Custom Attribute Definition
      operationId: DeleteCustomerCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.


        Deleting a custom attribute definition also deletes the corresponding custom attribute from

        all customer profiles in the seller''s Customer Directory.


        Only the definition owner can delete a custom attribute definition.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters:
      - name: key
        description: The key of the custom attribute definition to delete.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerCustomAttributeDefinitionResponse'
    get:
      tags:
      - CustomerCustomAttributes
      summary: Square Retrieve Customer Custom Attribute Definition
      operationId: RetrieveCustomerCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.


        To retrieve a custom attribute definition created by another application, the `visibility`

        setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_READ
      parameters:
      - name: key
        description: 'The key of the custom attribute definition to retrieve. If the requesting application

          is not the definition owner, you must use the qualified key.'
        schema:
          type: string
        in: path
        required: true
      - name: version
        description: 'The current version of the custom attribute definition, which is used for strongly consistent

          reads to guarantee that you receive the most up-to-date data. When included in the request,

          Square returns the specified version or a higher version if one exists. If the specified version

          is higher than the current version, Square returns a `BAD_REQUEST` error.'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerCustomAttributeDefinitionResponse'
    put:
      tags:
      - CustomerCustomAttributes
      summary: Square Update Customer Custom Attribute Definition
      operationId: UpdateCustomerCustomAttributeDefinition
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.


        Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the

        `schema` for a `Selection` data type.


        Only the definition owner can update a custom attribute definition. Note that sellers can view

        all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters:
      - name: key
        description: The key of the custom attribute definition to update.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerCustomAttributeDefinitionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomerCustomAttributeDefinitionResponse'
  /v2/customers/custom-attributes/bulk-upsert:
    post:
      tags:
      - CustomerCustomAttributes
      summary: Square Bulk Upsert Customer Custom Attributes
      operationId: BulkUpsertCustomerCustomAttributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation.


        Use this endpoint to set the value of one or more custom attributes for one or more customer profiles.

        A custom attribute is based on a custom attribute definition in a Square seller account, which is

        created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.


        This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert

        requests and returns a map of individual upsert responses. Each upsert request has a unique ID

        and provides a customer ID and custom attribute. Each upsert response is returned with the ID

        of the corresponding request.


        To create or update a custom attribute owned by another application, the `visibility` setting

        must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesResponse'
  /v2/customers/{customer_id}/custom-attributes:
    get:
      tags:
      - CustomerCustomAttributes
      summary: Square List Customer Custom Attributes
      operationId: ListCustomerCustomAttributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Lists the [custom attributes](entity:CustomAttribute) associated with a customer profile.


        You can use the `with_definitions` query parameter to also retrieve custom attribute definitions

        in the same call.


        When all response pages are retrieved, the results include all custom attributes that are

        visible to the requesting application, including those that are owned by other applications

        and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_READ
      parameters:
      - name: customer_id
        description: The ID of the target [customer profile](entity:Customer).
        schema:
          type: string
        in: path
        required: true
      - name: limit
        description: 'The maximum number of results to return in a single paged response. This limit is advisory.

          The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.

          The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: integer
        in: query
        required: false
      - name: cursor
        description: 'The cursor returned in the paged response from the previous call to this endpoint.

          Provide this cursor to retrieve the next page of results for your original request. For more

          information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      - name: with_definitions
        description: 'Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each

          custom attribute. Set this parameter to `true` to get the name and description of each custom

          attribute, information about the data type, or other definition details. The default value is `false`.'
        schema:
          type: boolean
          default: false
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerCustomAttributesResponse'
  /v2/customers/{customer_id}/custom-attributes/{key}:
    delete:
      tags:
      - CustomerCustomAttributes
      summary: Square Delete Customer Custom Attribute
      operationId: DeleteCustomerCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Deletes a [custom attribute](entity:CustomAttribute) associated with a customer profile.


        To delete a custom attribute owned by another application, the `visibility` setting must be

        `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters:
      - name: customer_id
        description: The ID of the target [customer profile](entity:Customer).
        schema:
          type: string
        in: path
        required: true
      - name: key
        description: 'The key of the custom attribute to delete. 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.'
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerCustomAttributeResponse'
    get:
      tags:
      - CustomerCustomAttributes
      summary: Square Retrieve Customer Custom Attribute
      operationId: RetrieveCustomerCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a [custom attribute](entity:CustomAttribute) associated with a customer profile.


        You can use the `with_definition` query parameter to also retrieve the custom attribute definition

        in the same call.


        To retrieve a custom attribute owned by another application, the `visibility` setting must be

        `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_READ
      parameters:
      - name: customer_id
        description: The ID of the target [customer profile](entity:Customer).
        schema:
          type: string
        in: path
        required: true
      - name: key
        description: 'The key of the custom attribute to retrieve. 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.'
        schema:
          type: string
        in: path
        required: true
      - name: with_definition
        description: 'Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of

          the custom attribute. Set this parameter to `true` to get the name and description of the custom

          attribute, information about the data type, or other definition details. The default value is `false`.'
        schema:
          type: boolean
          default: false
        in: query
        required: false
      - name: version
        description: 'The current version of the custom attribute, which is used for strongly consistent reads to

          guarantee that you receive the most up-to-date data. When included in the request, Square

          returns the specified version or a higher version if one exists. If the specified version is

          higher than the current version, Square returns a `BAD_REQUEST` error.'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerCustomAttributeResponse'
    post:
      tags:
      - CustomerCustomAttributes
      summary: Square Upsert Customer Custom Attribute
      operationId: UpsertCustomerCustomAttribute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates or updates a [custom attribute](entity:CustomAttribute) for a customer profile.


        Use this endpoint to set the value of a custom attribute for a specified customer profile.

        A custom attribute is based on a custom attribute definition in a Square seller account, which

        is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.


        To create or update a custom attribute owned by another application, the `visibility` setting

        must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

        (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      parameters:
      - name: customer_id
        description: The ID of the target [customer profile](entity:Customer).
        schema:
          type: string
        in: path
        required: true
      - name: key
        description: '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.'
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertCustomerCustomAttributeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertCustomerCustomAttributeResponse'
components:
  schemas:
    ListCustomerCustomAttributesResponse:
      type: object
      description: 'Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes) response.

        Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional

        results are available, the `cursor` field is also present along with `custom_attributes`.'
      x-release-status: PUBLIC
      properties:
        custom_attributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
          description: 'The retrieved custom attributes. If `with_definitions` was set to `true` in the request,

            the custom attribute definition is returned in the `definition` field of each custom attribute.


            If no custom attributes are found, Square returns an empty object (`{}`).'
        cursor:
          type: string
          description: 'The cursor to use in your next call to this endpoint to retrieve the next page of results

            for your original request. This field is present only if the request succeeded and additional

            results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
      example:
        custom_attributes:
        - created_at: '2022-04-26T15:50:27Z'
          key: favoritemovie
          updated_at: '2022-04-26T15:50:27Z'
          value: Dune
          version: 1
          visibility: VISIBILITY_READ_ONLY
        - created_at: '2022-04-26T15:51:53Z'
          key: ownsmovie
          updated_at: '2022-04-26T15:51:53Z'
          value: false
          version: 1
          visibility: VISIBILITY_HIDDEN
    BulkUpsertCustomerCustomAttributesResponse:
      type: object
      description: 'Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) response,

        which contains a map of responses that each corresponds to an individual upsert request.'
      x-release-status: PUBLIC
      properties:
        values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse'
          description: 'A map of responses that correspond to individual upsert requests. Each response has the

            same ID as the corresponding request and contains either a `customer_id` and `custom_attribute` or an `errors` field.'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
      example:
        values:
          id1:
            custom_attribute:
              created_at: '2021-12-08T23:14:47Z'
              key: favoritemovie
              updated_at: '2021-12-09T00:16:23Z'
              value: Dune
              version: 1
              visibility: VISIBILITY_READ_WRITE_VALUES
            customer_id: N3NCVYY3WS27HF0HKANA3R9FP8
          id2:
            custom_attribute:
              created_at: '2021-12-09T00:16:20Z'
              key: ownsmovie
              updated_at: '2021-12-09T00:16:23Z'
              value: false
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
            customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM
          id3:
            custom_attribute:
              created_at: '2021-12-09T00:16:20Z'
              key: favoritemovie
              updated_at: '2021-12-09T00:16:23Z'
              value: Star Wars
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
            customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM
          id4:
            custom_attribute:
              created_at: '2021-12-08T23:14:47Z'
              key: square:a0f1505a-2aa1-490d-91a8-8d31ff181808
              updated_at: '2021-12-09T00:16:23Z'
              value: '10.5'
              version: 1
              visibility: VISIBILITY_READ_WRITE_VALUES
            customer_id: N3NCVYY3WS27HF0HKANA3R9FP8
          id5:
            custom_attribute:
              created_at: '2021-12-09T00:16:20Z'
              key: sq0ids-0evKIskIGaY45fCyNL66aw:backupemail
              updated_at: '2021-12-09T00:16:23Z'
              value: fake-email@squareup.com
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
            customer_id: 70548QG1HN43B05G0KCZ4MMC1G
    UpdateCustomerCustomAttributeDefinitionResponse:
      type: object
      description: 'Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response.

        Either `custom_attribute_definition` or `errors` is present in the response.'
      x-release-status: PUBLIC
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
          description: The updated custom attribute definition.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
      example:
        custom_attribute_definition:
          created_at: '2022-04-26T15:27:30Z'
          description: Update the description as desired.
          key: favoritemovie
          name: Favorite Movie
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
          updated_at: '2022-04-26T15:39:38Z'
          version: 2
          visibility: VISIBILITY_READ_ONLY
    CustomAttributeDefinition:
      type: object
      description: 'Represents a definition for custom attribute values. A custom attribute definition

        specifies the key, visibility, schema, and other properties for a custom attribute.'
      x-release-status: PUBLIC
      properties:
        key:
          type:
          - string
          - 'null'
          description: 'The identifier

            of the custom attribute definition and its corresponding custom attributes. This value

            can be a simple key, which is the key that is provided when the custom attribute definition

            is created, or a qualified key, if the requesting

            application is not the definition owner. The qualified key consists of the application ID

            of the custom attribute definition owner

            followed by the simple key that was provided when the definition was created. It has the

            format application_id:simple key.


            The value for a simple key can contain up to 60 alphanumeric characters, periods (.),

            underscores (_), and hyphens (-).


            This field can not be changed

            after the custom attribute definition is created. This field is required when creating

            a definition and must be unique per application, seller, and resource type.'
          minLength: 1
          pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
        schema:
          type:
          - object
          - 'null'
          description: 'The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition.'
        name:
          type:
          - string
          - 'null'
          description: 'The name of the custom attribute definition for API and seller-facing UI purposes. The name must

            be unique within the seller and application pair. This field is required if the

            `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
          maxLength: 255
        description:
          type:
          - string
          - 'null'
          description: 'Seller-oriented description of the custom attribute definition, including any constraints

            that the seller should observe. May be displayed as a tooltip in Square UIs. This field is

            required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.'
          maxLength: 255
        visibility:
          $ref: '#/components/schemas/CustomAttributeDefinitionVisibility'
          description: 'Specifies how the custom attribute definition and its values should be shared with

            the seller and other applications. If no value is specified, the value defaults to `VISIBILITY_HIDDEN`.

            See [Visibility](#type-visibility) for possible values'
        version:
          type: integer
          description: 'Read only. The current version of the custom attribute definition.

            The value is incremented each time the custom attribute definition is updated.

            When updating a custom attribute definition, you can provide this field

            and specify the current version of the custom attribute definition to enable

            [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).


            On writes, this field must be set to the latest version. Stale writes are rejected.


            This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,

            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overv

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-customercustomattributes-api-openapi.yml