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.

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 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  icon to fetch a list of member IDs in the organization. You can use each row to specify a member or include multiple members separated by commas, in the same row.

Add Team Owners

Use this fieldset to add owners for the team. 

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. The Snap shows an error message if the member does not exist in the team.

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 team 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 all the members in the same row separated by a comma.

New Team Name

Default Value: N/A
Example: New_Contractors

String/Expression

Activates when you select the Rename Team option in the Operation field.

Specify a new name for the selected team.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

Activates when you select the Add Members, Remove Members, Rename Team, Delete Team, Archive Team, or Unarchive Team 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, Rename Team, Delete Team, Archive Team, or Unarchive Team option in the Operation field (Retries are NOT available for listing operations - List Members, List Teams, and List Channels).

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.

API returned error in Archive Team operation

The Snap request failed with 500. This typically indicates a server-side issue or an unexpected problem with the service.

Make sure the Snap settings are configured properly or reauthorize the account with valid values.

400 - Bad Request. Error in creating a channel.

The request to create the channel was invalid. 

Team ID needs to be a valid GUID

401 - Invalid Authentication Token

The provided authentication token is either expired, invalid, or does not have the necessary permissions to access this resource.

Ensure that you provide valid access token.