put

/channels/{channel_id}

Updates a Channel.

Updatable Fields

The following fields can be updated.

  • name
  • external_id
  • status
  • is_listable_from_ui
  • is_visible
  • is_enabled
  • config_meta

Note

  • Partial updates are supported. In most cases, if a field that cannot be updated is passed in, the API will not respond with an error. It returns a 200 response with the object, in which you will see the field(s) were not updated.
  • platform and type cannot be updated after a channel is created.
  • A channel with status deleted or terminated cannot be updated.

Authorization

apiKey - X-Auth-Token

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
config_meta
object

Optional channel configuration object.

external_id
string

Associated ID within a system / platform outside of BC.

is_listable_from_ui
boolean

Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.

is_visible
boolean

Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.

is_enabled
boolean

This field was originally used to turn on/off a channel but is deprecated. status should be used in place of is_enabled. Channel with status of prelaunch, active, or connected will have is_enabled set to true. Channel with status of inactive, disconnected, archived, deleted, or terminated will have is_enabled set to false.

1 validation
name
string

Name of the channel as it will appear to merchants in the control panel.

status
string

The status of the channel; channel type, platform, and status must be a valid combination. terminated is not valid for PUT or POST requests. deleted is not valid for POST requests.

1 validation

Responses

1 Example
Schema
object
$schema: http://json-schema.org/draft-04/schema#
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
1 variable not set
store_hash
X-Auth-Token