Update customer group

PUT https://app.ecwid.com/api/v3/{storeId}/customer_groups/{groupId}

Request and response example

Request:

PUT /api/v3/1003/customer_groups/9367001 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

{
  "name": "VIP Customers"
}

Response:

{
  "updateCount": 1
}

Required access scopes

Your app must have the following access scopes to make this request: update_customers

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.
groupId	number	Internal customer group ID.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Request JSON

A JSON object with the following fields:

Field	Type	Description
name	string	Customer group name visible to customers on the storefront.
externalReferenceId	string	External ID for syncing customer goups with other services.

Response JSON

A JSON object with the following fields:

Field	Type	Description
updateCount	number	The number of updated items that defines if the request was successful. One of: 1 if the item was updated, 0 if the item was not updated.