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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

A document containing details based on the operation to perform such as members' list for adding/removing members.

Output

Document

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • JSON Formatter + File Writer

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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

Field Name

Field Type

Field Dependency

Description

Label*

 

Default ValueChannel Operations
Example: 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 ValueAdd Members
Example: Rename Channel

String

N/A

Select the channel operation to perform.  Available options include:

  • Add Members: Activates the Team ID field, and Add Team Owners and Add Members field sets. 

  • Remove Members: Activates the Team ID field and Remove Members field sets.

  • List Members: Activates the Team ID field.

  • List Teams: Deactivates all fields except for the Snap Execution field. 

  • List Channels: Activates the Team ID field. Deactivates the remaining fields except for the Snap Execution field. 

  • Rename Team: Activates the Team ID and New Team Name fields.

  • Delete Team: Activates the Team ID field. 

  • Archive Team: Activates the Team ID field.

  • Unarchive Team: Activates the Team ID field.

Team ID*

 

Default Value: N/A
Example: b22e8da4-17c1-45c0-baa9-47aed7344e92

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
Example: e12b3456-7c89-012b-345f-67c89dca0bcd

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