Docs
Management API
Channel Settings

Customers V3

Get Customer Settings per Channel

GET /customers/settings/channels/{channel_id}

Request

Returns the customer settings per channel.

Notes

  • null indicates that there is no override per given channel and values are inherited from the global level.

Authentication

  • X-Auth-Token in header
    required

Parameters

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

example

Response

Customer settings for this channel are returned.

Body

object | application/json
  • data
    object

  • meta
    object

data

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
    required

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

Response

Customer settings are returned.

Body

object | application/json
  • data
    object

    Customer Settings.

  • meta
    object

example

Did you find what you were looking for?