Manage Customer Groups of Customer

Manage the customer groups of a customer, adding or removing the customer from those groups.

curl --location -g --request POST '{{BASE_URL}}/admin/customers//customer-groups' \ --header 'Content-Type: application/json' \ --data-raw '{ "add": [ "string" ], "remove": [ "string" ] }'

{ "customer": { "id": "string", "has_account": true, "groups": [ { "id": "string", "name": "string", "metadata": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "customers": [ {} ] } ], "email": "user@example.com", "default_billing_address_id": "string", "default_shipping_address_id": "string", "company_name": "string", "first_name": "string", "last_name": "string", "addresses": [ { "id": "string", "address_name": "string", "is_default_shipping": true, "is_default_billing": true, "customer_id": "string", "company": "string", "first_name": "string", "last_name": "string", "address_1": "string", "address_2": "string", "city": "string", "country_code": "us", "postal_code": "string", "phone": "string", "metadata": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "province": "us-ca" } ], "phone": "string", "metadata": {}, "created_by": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } }

Request

Authorization

Path Params

string

required

The customer's ID.

Query Params

fields

string

fields

optional

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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in
the Retrieve Custom Links documentation.

Body Params application/json

SUMMARY

add

array[string]

optional

The customer groups to add the customer to.

remove

array[string]

optional

The customer groups to remove the customer from.

Examples

Responses

🟢200OK

application/json

Body

The customer's details.

customer

object (AdminCustomer)

required

The customer's details.

string

required

The customer's ID.

has_account

boolean

has_account

required

Whether the customer is registered.

groups

array[object (AdminCustomerGroup) {6}]

optional

The customer's groups.

string <email>

required

The customer's email.

default_billing_address_id

string

default_billing_address_id

required

The ID of the address used as the default billing address.

default_shipping_address_id

string

default_shipping_address_id

required

The ID of the address used as the default shipping address.

company_name

string

company_name

required

The customer's company name.

first_name

string

first_name

required

The customer's first name.

last_name

string

last_name

required

The customer's last name.

addresses

array[object (AdminCustomerAddress) {18}]

required

The customer's addresses.

phone

string

phone

optional

The customer's phone.

metadata

object

optional

The customer's metadata, used to store custom key-value pairs.

created_by

string

created_by

optional

The ID of the user that created this customer, if available.

created_at

string <date-time>

created_at

optional

The customer's creation date.

updated_at

string <date-time>

updated_at

optional

The customer's update date.

deleted_at

string <date-time>

deleted_at

optional

The customer's deletion date.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error