Teams - Team Operations
In this article
Overview
You can use this Snap to perform the following team operations:
Add Members: Add members and team owners for a team.
Remove Members: Remove one or more members from a team.
List Members: Retrieve the list of members in a team
List Teams: Retrieve the list of all teams within the organization.
List Channels: Retrieve the list of channels within a team.
Rename Team: Change the name of a team.
Delete Team: Remove a team from the organization.
Archive Team: Archive a team.
Unarchive Team: Reactivate an archived team.
Snap Type
Teams - Team Operations Snap is a Write-type Snap that performs Team Operations like add/remove/list members, rename/delete teams, list channels, and archive/unarchive teams.
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 details based on the operation to perform such as members' list for adding/removing members. |
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:
| |
Team ID*
Default Value: N/A | String/Expression/Suggestion | Activates when you select the Add Members, Remove Members, List Members, List Channels, Rename Team, Delete Team, Archive Team, and Unarchive Team options in the Operation field. | Specify the ID of the team. Alternatively, click the icon to fetch a list of team IDs associated with the account. | |
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 ic |