> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Update Customer Group

> Updates a customer group as identified by the `group_id` value.

`square.updateCustomerGroup` updates a customer group as identified by the `group_id` value.

## Example

```ts automations/square-update-customer-group.automation.ts theme={null}
import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Update Square Customer Group", () => {
  onDashboardRun({ title: "Update Square Customer Group" })

  square.updateCustomerGroup({
    groupId: "group_id",
    group: {
      name: "Loyal Customers",
    },
  })
})
```

## Inputs

Every input accepts a compatible signal. It requires `CUSTOMERS_WRITE`.

| Field     | Type                   | Required | Default | Description                                                            |
| --------- | ---------------------- | -------- | ------- | ---------------------------------------------------------------------- |
| `groupId` | `string`               | Yes      | —       | The ID of the customer group to update.                                |
| `group`   | `Square.CustomerGroup` | Yes      | —       | The `CustomerGroup` object including all the updates you want to make. |

Use the official [UpdateCustomerGroup reference](https://developer.squareup.com/reference/square/customer-groups-api/update-customer-group) for provider field semantics and limits.

## Output

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