Update Customer Settings per Channel

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/customers/settings/channels/:channel_id

PUT

/stores/:store_hash/v3/customers/settings/channels/:channel_id

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/customers/settings/channels/1 \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "privacy_settings": {
    "ask_shopper_for_tracking_consent": true,
    "policy_url": "https://bigcommerce.com/policy"
  },
  "customer_group_settings": {
    "guest_customer_group_id": 0,
    "default_customer_group_id": 0
  },
  "allow_global_logins": true
}'

200Update channel customer settings

{
  "allow_global_logins": true,
  "customer_group_settings": {
    "default_customer_group_id": 0,
    "guest_customer_group_id": 0
  },
  "privacy_settings": {
    "ask_shopper_for_tracking_consent": true,
    "ask_shopper_for_tracking_consent_on_checkout": null,
    "policy_url": "https://bigcommerce.com/policy"
  }
}

Update the customer settings per channel

Required Fields

channel_id: Provide a channel_id array containing one or more channel IDs. Customers will have access to these channels and no others. This array cannot be empty.

Notes

Setting null will delete override per given channel, and values will be inherited from the global level. Make sure the channel has allow_global_logins enabled.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

channel_idintegerRequired

The ID of the channel.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

privacy_settingsobjectOptional

Controls the privacy settings.

customer_group_settingsobjectOptional

The settings for a collection of customers.

allow_global_loginsbooleanOptional

Determines if a channel allows global customer to login
Determines if customers created on this channel will get global access/login

Response

Customer settings are returned.

dataobjectOptional

Customer Settings.

metaobjectOptional