In this article

The page's title should always be the Snap's name.  For example, File Reader. 

Overview

Use this Snap to perform the following Channel operations in your Slack workspace:

• Archive channel
• Create channel
• Invite user
• List members
• Remove user
• Rename channel
• Retrieve channel info
• Unarchive channel

Provide a functional overview of the Snap. Do not mention anything about the Snap's internal technology or techniques. The user should be able to understand what the Snap. Include a screenshot of a well-configured Snap 600px.  

Prerequisites

Add valid Slack Scopes based on the intended operation. See Required Slack Scopes below for details.

Required Slack Scopes

Any action you want to perform within a Slack workspace additionally needs appropriate Scopes assigned to your app.  See the Scope and Permissions article in Slack API documentation for the complete list and each Account page under Configuring Slack Accounts for information on defining Scopes for your app.

List all prerequisites for using the Snap as a bullet list. Use direct sentences. For example, in case of a Write-type Snap a prerequisite would be that the user must have write access. Include links to external official documentation, if required. Use "None." if there no prerequisites. 

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

• Snaps in this Snap Pack use conditional display/hiding of fields. So, ensure that you always use the New Form UI (and not the classic UI) for the Snaps to function as designed/expected.
• Channel operations Archive Channel and Unarchive Channel cannot be performed using a Bot Token account. Use a User Token account instead.

List all Snap-specific limitations as a bullet list. Limitations can be imposed by the Snap's development environment and also by the endpoint's API. List both. Use direct sentences. Include links to external official documentation, if required. Use "None.: if there are no limitations.  

Known Issues

None.

Snap Input and Output

Type of view: Document/Binary/Both. Get number of views from the Views tab in the Snap. List at least three compatible Snaps in each category. Provide a brief of the input/output required. If the input/output is optional then preface the description with "Optional." For example, "Transaction data complying with the Orderful schema as a JSON document."

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String		Channel Operations	Channel Operations
Operation	Drop-down list	Select an operation from the following list of permitted channel operations and specify the corresponding details needed: List Members. To retrieve the list of users subscribed to a channel. Requires Channel.  Invite User. To invite a user in the workspace to a channel. Requires Channel and Users.  Remove User. To remove a user from a channel. Requires Channel and User.  Channel Info. To view the details of a channel, such as its creation date, purpose, creator, topic, locale, and the current number of members in the channel. Requires Channel. Create Channel. To create a new channel in the workspace. Requires Name and Private. Rename Channel. To rename an existing channel in the workspace. Requires Channel and New Name. Archive Channel. To archive an existing channel. Requires Channel. Unarchive Channel. To unarchive an archived channel. Requires Channel.	List Members	Invite User
Channel	String/Expression/Suggestion	Required for all channel operations except Create Channel. Click the  icon and select a channel from the list of suggested channels to perform the selected channel operation. Alternatively, you can enter the channel name and/or channel ID in one of the following formats. #channel.name:<11-character alphanumeric Channel ID> #channel.name <11-character alphanumeric Channel ID>	N/A	#testprivate:G019B3ETYMB
Users	String/Expression/Suggestion	Required for channel operation - Invite User. Click the  icon and select a user from the suggested list of users available in the workspace. Alternatively, you can enter one or more user IDs separated by commas. The user IDs are in the 11-character alphanumeric format. The specified users are invited to join the selected channel when you run the pipeline.	N/A	W01A94P7MK1, W01A94P7MK2, W01A94P7MK3
User	String/Expression/Suggestion	Required for channel operation - Remove User. Click the  icon and select a user from the suggested list of users available in the workspace. Alternatively, you can enter the user ID in the 11-character alphanumeric format. The specified user is removed from the selected channel when you run the pipeline.	N/A	W01A94P7MK1
Name	String/Expression	Required for channel operation - Create Channel. Enter a name for the new channel.	N/A	Support_Vertical
Private	Check box	Required for channel operation - Create Channel. Select this check box to keep the new channel private – visible to only members/invitees.	Not selected	Selected
New Name	String/Expression	Required for channel operation - Rename Channel. Enter the new name for the channel.	N/A	ReleaseTeam_Channel
Snap Execution	Drop-down list	Select one of the three following modes in which the Snap executes: Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled. Disables the Snap and all Snaps downstream from it.	Execute only	Validate & Execute

Troubleshooting

You can get information for this section from the Snap's source code, typically the Messages.java file in GitHub. Ask the developer to access this file. Do not use "Please" in the Reason or Resolution. If there is "Please" in the error message then contact the developer to have it removed as needed.

Examples

Include functional examples to demonstrate the various functionalities of the Snap. Examples are different from Use Cases. An example should focus on the Snap in question. Use first-person plural references. Start with the Pipeline's objective and then describe how you would go about using the Snap to fulfill this objective. Include all SLPs in the Downloads section. Use videos if a Snap's configuration is complex and difficult to capture using screenshots. Ensure that the screenshots are optically similar, the size of the text in the screenshots should be readable and similar in size. Max image size 1000 px. Screenshots must include: Pipeline, Snap Configs, Inputs, and Outputs. Refer to ELT Snaps for an instance.

Using Channel Operations Snap

Example title must be gerunds in title case.

Add a download link to the Pipeline in the the "Download" text above. Explain the Pipeline/Snap configuration in detail if a complex enough example has been used. Ensure that the functionality you are trying to illustrate is captured correctly. Include caveats as appropriate. To insert link: Press Ctrl + K --> Files --> Select the SLP file corresponding to the example. 

This example uses a series of Pipelines to demonstrate the different operations that you can perform on channels using the Channel Operations Snap. All operations carried out in this example are for demonstration purposes only and these Pipelines do not reflect any actual/real-time scenario.

1. A Pipeline with two Channel Operations Snaps to create a channel and invite one or more users to it.
2. A Pipeline with three Channel Operations Snaps to rename a channel and retrieve users and generic information about the channel.
3. The Remove user Snap to remove the user from the channel

Example 1: Create a channel and Invite User to join

This pipeline uses two features of the Channel Operations Snap – Create Channel and Invite User. The first Channel Operations Snap is configured to create a channel with a unique name defined as an expression. It creates the channel and displays its details in the output view.

The next Snap invites a user to the channel. It displays the result of the Invite User operation in the output view.

Example 2: Rename a channel and view its details and subscribers

This Pipeline uses three features of the Channel Operations Snap – Rename Channel, List Members and Channel Info. 

Channel Operations Snap (Rename Channel)	Output

The first Channel Operations Snap is configured to rename the channel generic_edit to generic_edited (for example purposes only). You can see the updated details in the output view. The Snap also retrieves the previous 10 names that the channel was given. The next Channel Operations Snap is configured to retrieve the list of members in the channel. 

Based on the channel specified, this Snap returns the list of all members in the channel. You can see the updated details in the output view. The Snap also returns the entire output from the previous Snap, for each member entry retrieved. The next Channel Operations Snap is configured to retrieve details of the channel.

Based on the channel selected in this Snap, it returns the details of the channel. You can see these details in the output view.

Example 3: Remove user from the channel

This Channel Operations Snap removes the specified user from the channel. It displays the result of the Remove User operation in the output view.

Downloads

Edit the Excerpt Include macro below to link to the Snap Pack page for this Snap page. Ensure that the heading Snap Pack History is not within the Snap Pack's history Excerpt. 

See Also

Provide links to the endpoint's official documentation, any relevant or related internal documentation, and any other links you have referred to on this page. Care should be taken when referencing external sites/documentation that it is an official site/documentation. Do not refer to forums such as stackoverflow.

• Slack Snap Pack
• Start building Slack apps
• Scopes and Permissions
• Snap Support for Ultra Pipelines
• SnapLogic Product Glossary
• Getting Started with SnapLogic