Archives a private channel.

Required Params

• channel - Private channel to archive

Errors the API can return:

• already_archived - Group has already been archived.
• channel_not_found - Value passed for channel was invalid.
• group_contains_others - Restricted accounts cannot archive groups containing others.
• last_ra_channel - You cannot archive the last channel for a restricted account.
• restricted_action - A team preference prevents the authenticated user from archiving.

Closes a private channel.

Required Params

• channel - Private channel to close.

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.

Creates a private channel.

Required Params

• name - Name of private channel to create

Errors the API can return:

• name_taken - A group cannot be created with the given name.
• no_channel - No group name was passed.
• restricted_action - A team preference prevents the authenticated user from creating groups.

Clones and archives a private channel.

Required Params

• channel - Private channel to clone and archive.

Errors the API can return:

• already_archived - An archived group cannot be cloned
• channel_not_found - Value passed for channel was invalid.
• restricted_action - A team preference prevents the authenticated user from creating groups.

Fetches history of messages and events from a private channel.

Required Params

• channel - Private channel to fetch history for.

Optional Params

• count - Number of messages to return, between 1 and 1000. ex: 100
• inclusive - Include messages with latest or oldest timestamp in results. ex: 1
• latest - End of time range of messages to include in results.
• oldest - Start of time range of messages to include in results.
• unreads - Include unread_count_display in the output? ex: 1

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• invalid_ts_latest - Value passed for latest was invalid
• invalid_ts_oldest - Value passed for oldest was invalid

Gets information about a private channel.

Required Params

• channel - Private channel to get info on

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.

Invites a user to a private channel.

Required Params

• channel - Private channel to invite user to.
• user - User to invite.

Errors the API can return:

• cant_invite - User cannot be invited to this group.
• cant_invite_self - Authenticated user cannot invite themselves to a group.
• channel_not_found - Value passed for channel was invalid.
• is_archived - Group has been archived.
• user_not_found - Value passed for user was invalid.

Removes a user from a private channel.

Required Params

• channel - Private channel to remove user from.
• user - User to remove from private channel.

Errors the API can return:

• cant_kick_self - You can't remove yourself from a group
• channel_not_found - Value passed for channel was invalid.
• not_in_group - User or caller were are not in the group
• restricted_action - A team preference prevents the authenticated user from kicking.
• user_not_found - Value passed for user was invalid.

Leaves a private channel.

Required Params

• channel - Private channel to leave

Errors the API can return:

• cant_leave_last_channel - Authenticated user cannot leave the last channel they are in
• channel_not_found - Value passed for channel was invalid.
• is_archived - Group has been archived.
• last_member - Authenticated user is the last member of a group and cannot leave it

Lists private channels that the calling user has access to.

Optional Params

• exclude_archived - Don't return archived private channels. ex: 1

Sets the read cursor in a private channel.

Required Params

• channel - Private channel to set reading cursor in.
• ts - Timestamp of the most recently seen message.

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• invalid_timestamp - Value passed for timestamp was invalid.

Opens a private channel.

Required Params

• channel - Private channel to open.

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.

Renames a private channel.

Required Params

• channel - Private channel to rename
• name - New name for private channel.

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• invalid_name - New name is invalid
• name_taken - New channel name is taken

Retrieve a thread of messages posted to a private channel.

Required Params

• channel - Private channel to fetch thread from
• thread_ts - Unique identifier of a thread's parent message.

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• thread_not_found - Value for thread_ts was missing or invalid.

Sets the purpose for a private channel.

Required Params

• channel - Private channel to set the purpose of
• purpose - The new purpose ex: My Purpose

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• is_archived - Private group has been archived
• too_long - Purpose was longer than 250 characters.
• user_is_restricted - Setting the purpose is a restricted action.

Sets the topic for a private channel.

Required Params

• channel - Private channel to set the topic of
• topic - The new topic ex: My Topic

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• is_archived - Private group has been archived
• too_long - Topic was longer than 250 characters.
• user_is_restricted - Setting the topic is a restricted action.

Unarchives a private channel.

Required Params

• channel - Private channel to unarchive

Errors the API can return:

• channel_not_found - Value passed for channel was invalid.
• not_archived - Group is not archived.