Update Account Group

Beta

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

Idempotent with Idempotency-Key header. Learn more

Partially updates an account group.

Only the provided fields are changed. The account group's type cannot be changed after creation, and renaming the group to a name another group in your account already uses returns a conflict error.

A new commission or freight policy takes effect for every account already in the group, not just accounts added afterwards.

Permissions requiredValues:customer_groups:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Account group ID.

nameoptional string

Display name of the account group.

Must be unique within your account.

descriptionoptional stringnullable

Free-form description of the account group. Send null to clear.

commission_policyoptional stringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policyoptional stringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysoptional integernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has not set its own. Clearing it returns the group's customers to the account default. Send null to clear.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

typestringenumValues:pricing_grouptype_group

How this account group is used.

pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
type_group: used to categorize accounts, such as "Consumers" or "Distributors".

A group's type is fixed when it is created and cannot be changed afterwards.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

commission_applied: sales commission is calculated on orders from accounts in this group.
commission_exempt: orders from accounts in this group are exempt from commission.

freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

free_freight: customers within this group will not have to pay for freight.
billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.

default_lead_time_daysintegernullable

Calendar days between an order being issued and it being due to ship, inherited by every customer in this group that has neither set its own nor inherited one from a parent account.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Account Group

Update Account Group

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountGroup = await client.sales.accountGroups.update('acgp_6p4z57e9alaf', {
  commission_policy: 'commission_exempt',
  description: 'Customers who buy in bulk at wholesale pricing.',
  freight_policy: 'billed_freight',
  name: 'Updated Wholesale Customers',
});

console.log(accountGroup.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountGroup = await client.sales.accountGroups.update('acgp_6p4z57e9alaf', {
  commission_policy: 'commission_exempt',
  description: 'Customers who buy in bulk at wholesale pricing.',
  freight_policy: 'billed_freight',
  name: 'Updated Wholesale Customers',
});

console.log(accountGroup.id);

200 example

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

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

Update Account Group

Authorization

Path Parameters

Request Body

Returns

Responses