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.

Label*

Default Value: Channel 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 Value: Add 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.

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  icon to fetch a list of team IDs associated with the account. 

Channel ID*

Default Value: N/A
Example: Chat, teams, channels and apps : 12:34ab567d89012b34b0fba40f987f2f3d@thread.tacv2

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. 

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

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
Example: New_Contractors

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
Example: 3

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. 

Retry Interval (seconds)

Default Value: 1
Example: 6

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.

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown list

N/A

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.

Unsupported Operation

You tried adding members to a public channel.

Verify whether the specified/selected channel is a public channel.

Channel Operations Snap to add members to a channel

Output

Copy Snap

Output

Channel Operations Snap to rename a channel

Output

Removing Members Snap to remove member from channel

Output