square-connect-openapi-agent/skills/customers/SKILL.md

name, description

name	description
customers-routes	Handle 31 OpenAPI operation(s) under /v2/customers for the customers route group.

customers API Routes

Handle 31 OpenAPI operation(s) under /v2/customers for the customers route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

list_customers

• Operation ID: list_customers
• Route: GET /v2/customers
• Mode: READ
• Summary: ListCustomers
• Parameters:
  • cursor in query
  • limit in query
  • sort_field in query
  • sort_order in query
  • count in query

create_customer

• Operation ID: create_customer
• Route: POST /v2/customers
• Mode: WRITE
• Summary: CreateCustomer
• Body: JSON request body accepted.

bulk_create_customers

• Operation ID: bulk_create_customers
• Route: POST /v2/customers/bulk-create
• Mode: WRITE
• Summary: BulkCreateCustomers
• Body: JSON request body accepted.

bulk_delete_customers

• Operation ID: bulk_delete_customers
• Route: POST /v2/customers/bulk-delete
• Mode: WRITE
• Summary: BulkDeleteCustomers
• Body: JSON request body accepted.

bulk_retrieve_customers

• Operation ID: bulk_retrieve_customers
• Route: POST /v2/customers/bulk-retrieve
• Mode: WRITE
• Summary: BulkRetrieveCustomers
• Body: JSON request body accepted.

bulk_update_customers

• Operation ID: bulk_update_customers
• Route: POST /v2/customers/bulk-update
• Mode: WRITE
• Summary: BulkUpdateCustomers
• Body: JSON request body accepted.

list_customer_custom_attribute_definitions

• Operation ID: list_customer_custom_attribute_definitions
• Route: GET /v2/customers/custom-attribute-definitions
• Mode: READ
• Summary: ListCustomerCustomAttributeDefinitions
• Parameters:
  • limit in query
  • cursor in query

create_customer_custom_attribute_definition

• Operation ID: create_customer_custom_attribute_definition
• Route: POST /v2/customers/custom-attribute-definitions
• Mode: WRITE
• Summary: CreateCustomerCustomAttributeDefinition
• Body: JSON request body accepted.

delete_customer_custom_attribute_definition

• Operation ID: delete_customer_custom_attribute_definition
• Route: DELETE /v2/customers/custom-attribute-definitions/{key}
• Mode: WRITE
• Summary: DeleteCustomerCustomAttributeDefinition
• Parameters:
  • key in path required

retrieve_customer_custom_attribute_definition

• Operation ID: retrieve_customer_custom_attribute_definition
• Route: GET /v2/customers/custom-attribute-definitions/{key}
• Mode: READ
• Summary: RetrieveCustomerCustomAttributeDefinition
• Parameters:
  • key in path required
  • version in query

update_customer_custom_attribute_definition

• Operation ID: update_customer_custom_attribute_definition
• Route: PUT /v2/customers/custom-attribute-definitions/{key}
• Mode: WRITE
• Summary: UpdateCustomerCustomAttributeDefinition
• Parameters:
  • key in path required
• Body: JSON request body accepted.

bulk_upsert_customer_custom_attributes

• Operation ID: bulk_upsert_customer_custom_attributes
• Route: POST /v2/customers/custom-attributes/bulk-upsert
• Mode: WRITE
• Summary: BulkUpsertCustomerCustomAttributes
• Body: JSON request body accepted.

list_customer_groups

• Operation ID: list_customer_groups
• Route: GET /v2/customers/groups
• Mode: READ
• Summary: ListCustomerGroups
• Parameters:
  • cursor in query
  • limit in query

create_customer_group

• Operation ID: create_customer_group
• Route: POST /v2/customers/groups
• Mode: WRITE
• Summary: CreateCustomerGroup
• Body: JSON request body accepted.

delete_customer_group

• Operation ID: delete_customer_group
• Route: DELETE /v2/customers/groups/{group_id}
• Mode: WRITE
• Summary: DeleteCustomerGroup
• Parameters:
  • group_id in path required

retrieve_customer_group

• Operation ID: retrieve_customer_group
• Route: GET /v2/customers/groups/{group_id}
• Mode: READ
• Summary: RetrieveCustomerGroup
• Parameters:
  • group_id in path required

update_customer_group

• Operation ID: update_customer_group
• Route: PUT /v2/customers/groups/{group_id}
• Mode: WRITE
• Summary: UpdateCustomerGroup
• Parameters:
  • group_id in path required
• Body: JSON request body accepted.

search_customers

• Operation ID: search_customers
• Route: POST /v2/customers/search
• Mode: WRITE
• Summary: SearchCustomers
• Body: JSON request body accepted.

list_customer_segments

• Operation ID: list_customer_segments
• Route: GET /v2/customers/segments
• Mode: READ
• Summary: ListCustomerSegments
• Parameters:
  • cursor in query
  • limit in query

retrieve_customer_segment

• Operation ID: retrieve_customer_segment
• Route: GET /v2/customers/segments/{segment_id}
• Mode: READ
• Summary: RetrieveCustomerSegment
• Parameters:
  • segment_id in path required

delete_customer

• Operation ID: delete_customer
• Route: DELETE /v2/customers/{customer_id}
• Mode: WRITE
• Summary: DeleteCustomer
• Parameters:
  • customer_id in path required
  • version in query

retrieve_customer

• Operation ID: retrieve_customer
• Route: GET /v2/customers/{customer_id}
• Mode: READ
• Summary: RetrieveCustomer
• Parameters:
  • customer_id in path required

update_customer

• Operation ID: update_customer
• Route: PUT /v2/customers/{customer_id}
• Mode: WRITE
• Summary: UpdateCustomer
• Parameters:
  • customer_id in path required
• Body: JSON request body accepted.

create_customer_card

• Operation ID: create_customer_card
• Route: POST /v2/customers/{customer_id}/cards
• Mode: WRITE
• Summary: CreateCustomerCard
• Parameters:
  • customer_id in path required
• Body: JSON request body accepted.

delete_customer_card

• Operation ID: delete_customer_card
• Route: DELETE /v2/customers/{customer_id}/cards/{card_id}
• Mode: WRITE
• Summary: DeleteCustomerCard
• Parameters:
  • customer_id in path required
  • card_id in path required

list_customer_custom_attributes

• Operation ID: list_customer_custom_attributes
• Route: GET /v2/customers/{customer_id}/custom-attributes
• Mode: READ
• Summary: ListCustomerCustomAttributes
• Parameters:
  • customer_id in path required
  • limit in query
  • cursor in query
  • with_definitions in query

delete_customer_custom_attribute

• Operation ID: delete_customer_custom_attribute
• Route: DELETE /v2/customers/{customer_id}/custom-attributes/{key}
• Mode: WRITE
• Summary: DeleteCustomerCustomAttribute
• Parameters:
  • customer_id in path required
  • key in path required

retrieve_customer_custom_attribute

• Operation ID: retrieve_customer_custom_attribute
• Route: GET /v2/customers/{customer_id}/custom-attributes/{key}
• Mode: READ
• Summary: RetrieveCustomerCustomAttribute
• Parameters:
  • customer_id in path required
  • key in path required
  • with_definition in query
  • version in query

upsert_customer_custom_attribute

• Operation ID: upsert_customer_custom_attribute
• Route: POST /v2/customers/{customer_id}/custom-attributes/{key}
• Mode: WRITE
• Summary: UpsertCustomerCustomAttribute
• Parameters:
  • customer_id in path required
  • key in path required
• Body: JSON request body accepted.

remove_group_from_customer

• Operation ID: remove_group_from_customer
• Route: DELETE /v2/customers/{customer_id}/groups/{group_id}
• Mode: WRITE
• Summary: RemoveGroupFromCustomer
• Parameters:
  • customer_id in path required
  • group_id in path required

add_group_to_customer

• Operation ID: add_group_to_customer
• Route: PUT /v2/customers/{customer_id}/groups/{group_id}
• Mode: WRITE
• Summary: AddGroupToCustomer
• Parameters:
  • customer_id in path required
  • group_id in path required