Alokai

CreateChannelParams

Necessary parameters to create a channel.

interface CreateChannelParams {
	name: string;
	platform: string;
	status: ChannelStatus;
	type: ChannelType;
}

Properties

NameRequiredTypeDescription
nameRequiredstringName of the channel as it will appear to merchants in the control panel.
platformRequiredstringThe name of the platform for the channel; channel platform and type must be a valid combination.
statusRequiredChannelStatusThe 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.
typeRequiredChannelTypeThe type of channel; channel platform and type must be a valid combination.

Referenced Types

On this page