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

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 channel details, member list, team ID, or channel ID.

Output

Document

  • Min: 1

  • Max: 1

  • JSON Formatter + File Writer

  • Mapper

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 Add Members and Add Channel Owners field sets, and the Number of Retries and Retry Interval (seconds) fields.

  • Remove Members: Activates the Remove Members field set, and the Number of Retries and Retry Interval (seconds) fields.

  • List Members:

  • Rename Channel: Activates the New Channel Name, Number of Retries, and Retry Interval (seconds) fields.

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
Example: b22e8da4-17c1-45c0-baa9-47aed7344e92

String/Expression/Suggestion

N/A

Specify the ID of the team. Alternatively, click the