Skip to main content

Remove From Channel

UiPath.Slack.Activities.Channels.RemoveFromChannel

Overview​

The Remove From Channel activity uses the Slack conversations.kick API to remove a specific Slack user (User) from an existing channel (Channel) that you're a member and administrator of.

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Slack Scope activity to your project.
  3. Add the Remove From Channel activity inside the Slack Scope activity.
  4. Enter values for the Input properties.
  5. Run the activity.

In the Body of the Activity​

  • Channel Name - The channel that you want to remove a specified User from. Enter a valid channel name String or use the drop-down list to select a channel from your workspace.
    • You must be a member and administrator of the channel to invite new members.
    • Before you can select a channel, the Slack Scope must be connected to the workspace. Connecting to the workspace is done by clicking the Connect button in the Slack Scope activity.
  • User - A specific Slack user that you want to remove from the selected Channel. Enter a String or String variable.
    • Enter your name using Slack notation (e.g.,"Jean.Grey").
    • Only one user may be removed at a time with this activity.

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.