Update Account Group

Beta

PATCH/v1/sales/account-groups/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates an account group.

idstring

Account group ID.

nameoptional string

Display name.

descriptionoptional stringnullable

Description. Send null to clear.

commission_policyoptional stringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policyoptional stringenumValues:free_freightbilled_freight

Freight policy.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

typestringenumValues:pricing_grouptype_group

Account group type.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Account Group

Update Account Group

curl API_HOST/v1/sales/account-groups/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Wholesale Customers"
}'

curl API_HOST/v1/sales/account-groups/{id} \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Updated Wholesale Customers"
}'

200 example

{
  "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "account_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "type": "type_group",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acgp_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "account_group",
  "name": "Wholesale Customers",
  "description": null,
  "commission_policy": "commission_applied",
  "freight_policy": "billed_freight",
  "type": "type_group",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Account Group

Path Parameters

Request Body

Returns

Responses