Create channel

The chat.createChannel method on a Client instance makes a POST request to the chat/channels endpoint and returns the created or rejoined channel.

Warning: This endpoint is not tested, you may or may not run into unexpected behavior.

Parameters

Parameter	Type	Optional	Description
type	‘PM’ | ‘ANNOUNCE’		Channel type to create or rejoin

If type is set to PM then the parameters are as follows:

Parameter	Type	Optional	Description
type	‘PM’
options	CreatePMChannelOptions

options.body

Parameter	Type	Optional	Description
target_id	number		Target user ID
message	string	✓	Message to send
channel	ChannelDetails	✓	Channel details
channel.name	string	✓	Channel name
channel.description	string	✓	Channel description

If type is set to ANNOUNCE then the parameters are as follows:

Parameter	Type	Optional	Description
type	‘ANNOUNCE’
options	CreateAnnounceChannelOptions

options.body

Parameter	Type	Optional	Description
message	string		Message to send with the announcement
target_ids	number[]		Target user IDs
channel	ChannelDetails		Channel details
channel.name	string		Channel name
channel.description	string		Channel description

Returns

Promise<Channel>;

Types

• Channel

Possible Exceptions

See the error handling documentation for more information.

• invalid_json_syntax
• network_error
• unexpected_response

Notice that something is missing? Found a typo? Think something's incomplete? Or think that something can be explained better? Feel free to open a pull request or submit an issue on the library's Github repository .