Docs
Management API
Customers V3
Channel Settings

Channel Settings

Get Customer Settings per Channel

GET /customers/settings/channels/{channel_id}

Request

Returns the customer settings per channel.

Notes:

  • null value configuration indicates that there is no override provided for a given channel; thus, values are inherited from Global Settings.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • channel_id in path - integer
    required

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/customers/settings/channels/[channel_id]' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Customer settings for this channel are returned.

Body

object | application/json

  • data    object

  • meta    object

data

{
"privacy_settings": {
"ask_shopper_for_tracking_consent": true,
"policy_url": "https://bigcommmerce.com/policy"
},
"customer_group_settings": {
"guest_customer_group_id": 1,
"allow_global_logins": true
}
}

Update Customer Settings per Channel

PUT /customers/settings/channels/{channel_id}

Request

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-Token in header

Parameters

  • store_hash in path - string
  • channel_id in path - integer
    required

Body

object | application/json

  • privacy_settings    object

    Controls the privacy settings.

  • customer_group_settings    object

    The settings for a collection of customers.

  • allow_global_logins    boolean

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

example-1

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

Response

Customer settings are returned.

Body

object | application/json

  • data    object

    Customer Settings.

  • meta    object

example

{
"privacy_settings": {
"ask_shopper_for_tracking_consent": true,
"policy_url": "https://bigcommmerce.com/policy",
"ask_shopper_for_tracking_consent_on_checkout": null
},
"customer_group_settings": {
"guest_customer_group_id": 0,
"default_customer_group_id": 0
},
"allow_global_logins": true
}
Did you find what you were looking for?
Delete Customer AttributesGet Customer Settings per Channel