post

/channels

Creates a Channel.

Authorization

apiKey - X-Auth-Token

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
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
name
string

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

required
type
string

The type of channel; channel platform and type must be a valid combination.

1 validation + required
platform
string

The name of the platform for the channel; channel platform and type must be a valid combination.

required

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)
$$.env
1 variable not set
store_hash
X-Auth-Token