put

/channels/{channel_id}

Updates a Channel. Partial updates are supported. Currently, if a field that cannot be updated is passed in, the API not respond with an error.

Fields That Can Be Updated

  • name
  • external_id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
name
string

Name of the channel as it will appear to merchants in BC

external_id
string

Associated ID within a system / platform outside of BC.

is_enabled
boolean

Determines whether the channel is enabled on a store. In order to disable a channel, set is_enabled to false.

This results in the channel not showing in the ‘Products’ section of the BC control panel.

1 validation
status
string
1 validation

Responses

1 Example
Schema
object
data
object
meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
channel_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token