Skip to main content
POST
/
admin
/
customer-groups
/
{id}
JS SDK
import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customerGroup.update("cusgroup_123", {
  name: "VIP"
})
.then(({ customer_group }) => {
  console.log(customer_group)
})
{
  "customer_group": {
    "id": "<string>",
    "name": "<string>",
    "customers": [
      {}
    ],
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The customer group's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The details to update in a customer group.

​
name
string

The customer group's name.

​
metadata
object

The customer group's metadata, can hold custom key-value pairs.

Response

OK

The customer group's details.

​
customer_group
object
required

The customer group's details.