Teams - Channel Operations
In this article
Overview
You can use this Snap to perform the following operations upon the specified channel:
Add members
Remove members
List members
Rename channel
Snap Type
Teams - Channel Operations Snap is a Write-type Snap that performs channel operations like add/remove/list members and updating channel names.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations & Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| A document containing channel details, member list, team ID, or channel ID. |
Output | Document |
|
| A document containing details of the selected operation's execution. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | |||
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
Field Name | Field Type | Field Dependency | Description | |
|---|---|---|---|---|
Label*
Default Value: Channel Operations | String | N/A | Specify a unique name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |
Operation*
Default Value: Add Members | String | N/A | Select the channel operation to perform. Available options include:
Add/Remove Members You can add or remove members in private channels only. Public channels contain all team members, by default. | |
Team ID*
Default Value: N/A | String/Expression/Suggestion | N/A | Specify the ID of the team. Alternatively, click the icon to fetch a list of team IDs associated with the account. | |
Channel ID*
Default Value: N/A | String/Expression/Suggestion | N/A | Specify the ID of the target channel that belongs to the selected team. Alternatively, click the icon to fetch a list of channel IDs associated with the specified team. Channel ID format Use this format to specify the channel in this field: <Channel_Name><space>:<space><Channel_ID> | |
Add Members | Use this fieldset to add members to the channel. | |||
Member ID
Default Value: N/A | String/Expression/Suggestion | Activates when you select the Add Members option in the Operation field. | Specify the ID of the member to add. Alternatively, click the icon to fetch a list of member IDs associated with the team. You can use each row to specify a member or include multiple members separated by commas, in the same row. | |
Add Channel Owners | Use this fieldset to assign owners for the channel. | |||
Owner ID
Default Value: N/A | String/Expression/Suggestion | Activates when you select the Add Members option in the Operation field.
| Specify the ID of the member. Alternatively, click the icon to fetch a list of member IDs associated with the team. You can use each row to specify an owner or include multiple owners separated by commas, in the same row. | |
Remove Members | Use this fieldset to remove members from the channel. | |||
Member ID
Default Value: N/A | String/Expression/Suggestion | Activates when you select the Remove Members option in the Operation field.
| Specify the ID of the member to remove. Alternatively, click the icon to fetch a list of member IDs associated with the team. You can use each row to specify a member or include multiple members separated by commas, in the same row. | |
New Channel Name
Default Value: N/A | String/Expression | Activates when you select the Rename Channel option in the Operation field.
| Specify the new name for the channel. | |
Number of Retries
Default Value: 0 | Integer/Expression | Activates when you select the Add Members, Remove Members, or Rename Channel option in the Operation field. | Specify the number of attempts the Snap makes to perform the selected operation in case of connection failure/unsuccessful attempts. To avoid 502 Bad Gateway error Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. | |
Retry Interval (seconds)
Default Value: 1 | Integer/Expression | Activates when you select the Add Members, Remove Members, or Rename Channel option in the Operation field. | Specify the time interval in seconds between retry attempts. To avoid 502 Bad Gateway error Use a higher value (such as 3, 4, or more) in this field to ensure the Snap/Pipeline runs successfully. | |
Snap Execution
Default Value: Execute only | Dropdown list | N/A | Select one of the three following modes in which the Snap executes:
| |
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2025 SnapLogic, Inc.