Slackbot

Parámetros de entrada

• num_minutesstringObligatorio

  Number of minutes, from now, to snooze until.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstringObligatorio

  The URL of the image file to be used as the custom emoji. The image should be accessible via HTTP/HTTPS and meet Slack's emoji requirements (e.g., size, format). Supported formats typically include PNG, GIF, and JPEG.

• namestringObligatorio

  The desired name for the new custom emoji. This name will be used to invoke the emoji (e.g., if name is 'partyparrot', it's used as ':partyparrot:'). Colons around the name are not required when providing this field.

• tokenstringObligatorio

  Authentication token used to authorize the request to add a custom emoji to the Slack workspace.

Parámetros de salida

• dataobjectObligatorio

  The response data confirming the successful addition of the custom emoji.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The new alias to be created for the emoji specified in `alias_for` (e.g., `new_emoji_alias`). Colons around the name (e.g., `:my_alias:`) are optional and will be automatically trimmed, along with any leading/trailing whitespace.

• tokenstringObligatorio

  Authentication token. Requires the `admin.teams:write` scope.

• alias_forstringObligatorio

  The canonical name of the existing custom emoji (e.g., `original_emoji`).

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API. It typically contains an `ok` field which is `true` if the alias was added successfully.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  Title of the remote file to be displayed in Slack.

• tokenstring

  Slack authentication token, required to authorize adding the remote file.

• filetypestring

  File type (e.g., 'pdf', 'docx', 'png') to help Slack display appropriate icons or previews.

• external_idstring

  Unique identifier for the file, defined by the calling application, used for future API references (e.g., updating, deleting).

• external_urlstring

  Publicly accessible or permissioned URL of the remote file, used by Slack to access its content or metadata.

• preview_imagestring

  Base64-encoded image (e.g., PNG, JPEG) used as the file's preview in Slack.

• indexable_file_contentsstring

  Plain text content of the file, indexed by Slack for search.

Parámetros de salida

• dataobjectObligatorio

  Contains a confirmation object indicating the success of the file addition.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  ID of the file to add a star to.

• channelstring

  ID of the channel to star. If starring a specific message, this is the ID of the channel containing the message, and `timestamp` must also be provided.

• timestampstring

  Timestamp of the message to add a star to. This uniquely identifies the message within the specified `channel`. Requires `channel` to also be provided.

• file_commentstring

  ID of the file comment to add a star to.

Parámetros de salida

• dataobjectObligatorio

  Contains the API call's success status. The `ok` field within this model will be `True` if the star was added.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  ID of the call returned by the add method.

• usersstringObligatorio

  The list of users to add as participants in the call. users is a JSON array (formatted as a string) containing information for each user. Each element should include both a `slack_id` and optionally an `external_id`. For example: `[{"slack_id": "U1H77", "external_id": "ext-id"}]`.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlstringObligatorio

  The URL of the image file to be used as the custom emoji. The image should be accessible via HTTP/HTTPS and meet Slack's emoji requirements (e.g., size, format). Supported formats typically include PNG, GIF, and JPEG.

• namestringObligatorio

  The desired name for the new custom emoji. This name will be used to invoke the emoji (e.g., if name is 'partyparrot', it's used as ':partyparrot:'). Colons around the name are not required when providing this field.

• tokenstringObligatorio

  Authentication token used to authorize the request to add a custom emoji to the Slack workspace.

Parámetros de salida

• dataobjectObligatorio

  The response data confirming the successful addition of the custom emoji.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the emoji to add as a reaction (e.g., 'thumbsup'). This is the emoji name without colons. For emojis with skin tone modifiers, append '::skin-tone-X' where X is a number from 2 to 6 (e.g., 'wave::skin-tone-3').

• channelstringObligatorio

  ID of the channel where the message to add the reaction to was posted.

• timestampstringObligatorio

  Timestamp of the message to which the reaction will be added. This is a unique identifier for the message, typically a string representing a float value like '1234567890.123456'.

Parámetros de salida

• dataobjectObligatorio

  Wrapper for the response data, indicating the outcome of the add reaction operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  ID of the Slack conversation to archive. This ID uniquely identifies a channel (e.g., public, private).

Parámetros de salida

• dataobjectObligatorio

  The response from the Slack API, primarily indicating the success or failure of the archive operation. Includes an 'ok' field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channel_idstringObligatorio

  ID of the public or private Slack channel to archive.

Parámetros de salida

• dataobjectObligatorio

  Result of the archive operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  DEPRECATED: This sends raw text only, use markdown_text field. Primary textual content. Recommended fallback if using `blocks` or `attachments`. Supports mrkdwn unless `mrkdwn` is `false`.

• parsestring

  Message text parsing behavior. Default `none` (no special parsing). `full` parses as user-typed (links @mentions, #channels). See Slack API docs for details.

• blocksstring

  DEPRECATED: Use `markdown_text` field instead. URL-encoded JSON array of layout blocks for rich/interactive messages. See Slack API Block Kit docs for structure.

• mrkdwnboolean

  Disable Slack's markdown for `text` field if `false`. Default `true` (allows *bold*, _italic_, etc.).

• as_userboolean

  Post as the authenticated user instead of as a bot. Defaults to `false`. If `true`, `username`, `icon_emoji`, and `icon_url` are ignored. If `false`, the message is posted as a bot, allowing appearance customization.

• channelstringObligatorio

  ID or name of the channel, private group, or IM channel to send the message to.

• icon_urlstring

  Image URL for bot's icon (must be HTTPS). Applies if `as_user` is `false`.

• usernamestring

  Bot's name in Slack (max 80 chars). Applies if `as_user` is `false`.

• thread_tsstring

  Timestamp (`ts`) of an existing message to make this a threaded reply. Use `ts` of the parent message, not another reply. Example: '1476746824.000004'.

• icon_emojistring

  Emoji for bot's icon (e.g., ':robot_face:'). Overrides `icon_url`. Applies if `as_user` is `false`.

• link_namesboolean

  Automatically hyperlink channel names (e.g., #channel) and usernames (e.g., @user) in message text. Defaults to `false` for bot messages.

• attachmentsstring

  URL-encoded JSON array of message attachments, a legacy method for rich content. See Slack API documentation for structure.

• unfurl_linksboolean

  Enable unfurling of text-based URLs. Defaults `false` for bots, `true` if `as_user` is `true`.

• unfurl_mediaboolean

  Disable unfurling of media content from URLs if `false`. Defaults to `true`.

• markdown_textstring

  PREFERRED: Write your message in markdown for nicely formatted display. Supports: headers (# ## ###), bold (**text** or __text__), italic (*text* or _text_), strikethrough (~~text~~), inline code (`code`), code blocks (```), links ([text](url)), block quotes (>), lists (- item, 1. item), dividers (--- or ***), context blocks (:::context with images), and section buttons (:::section-button). IMPORTANT: Use \n for line breaks (e.g., 'Line 1\nLine 2'), not actual newlines. USER MENTIONS: To tag users, use their user ID with <@USER_ID> format (e.g., <@U1234567890>), not username.

• reply_broadcastboolean

  If `true` for a threaded reply, also posts to main channel. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Contains the posted message details including the message object and metadata like channel ID and timestamp.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  The ID of the direct message or multi-person direct message channel to close. Example: D1234567890 or G0123456789.

Parámetros de salida

• dataobjectObligatorio

  The response data containing the status of the close operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstringObligatorio

  The textual content of the reminder message.

• timestringObligatorio

  Specifies when the reminder should occur. This can be a Unix timestamp (integer, up to five years from now), the number of seconds until the reminder (integer, if within 24 hours, e.g., '300' for 5 minutes), or a natural language description (string, e.g., "in 15 minutes," or "every Thursday at 2pm", "daily").

• userstring

  The ID of the user who will receive the reminder (e.g., 'U012AB3CD4E'). If not specified, the reminder will be sent to the user who created it.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API, including the success status and reminder details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Unique name for the User Group. Must be unique among all User Groups in the workspace.

• handlestring

  Unique mention handle. Must be unique across channels, users, and other User Groups. Max 21 chars; lowercase letters, numbers, hyphens, underscores only.

• channelsstring

  Comma-separated encoded channel IDs for default channels, suggested when mentioning or inviting the group.

• descriptionstring

  Short description for the User Group.

• include_countboolean

  Include the User Group's user count in the response. Server defaults to `false` if omitted.

Parámetros de salida

• dataobjectObligatorio

  Contains the creation result and details of the new User Group.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the public or private channel to create

• team_idstring

  encoded team id to create the channel in, required if org token is used

• is_privateboolean

  Create a private channel instead of a public one

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new channel. Must be unique, 80 characters or fewer, lowercase, without spaces or periods, and may contain letters, numbers, and hyphens.

• team_idstring

  Workspace (team) ID for channel creation (e.g., T123ABCDEFG). Required if `org_wide` is `false` or not set.

• org_wideboolean

  Set to `true` to make the channel available org-wide. If `false` or not set, `team_id` is required.

• is_privatebooleanObligatorio

  Set to `true` to make the channel private, or `false` for public.

• descriptionstring

  Optional description for the channel (e.g., 'Discussion about Q4 marketing strategies').

Parámetros de salida

• dataobjectObligatorio

  Contains the details of the created channel, including its ID and a success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsstringObligatorio

  Timestamp of the message to customize URL unfurling for.

• channelstringObligatorio

  Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.

• unfurlsstring

  URL-encoded JSON mapping message URLs to custom unfurl content (Slack attachment format or unfurl blocks). To remove an existing unfurl, provide an empty unfurl block for its URL.

• user_auth_urlstring

  URL-encoded custom URL for user authentication with your app to enable unfurling. Used when `user_auth_required` is true.

• user_auth_messagestring

  Ephemeral message text prompting user authentication with your app for domain-specific unfurling. Used when `user_auth_required` is true and authorization is pending.

• user_auth_requiredboolean

  Set to `true` if user authentication is required to unfurl links for a domain, enabling an authentication flow using `user_auth_url` and `user_auth_message`.

Parámetros de salida

• dataobjectObligatorio

  Contains an `ok` field which indicates if the request to customize unfurling was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsstringObligatorio

  Timestamp of the message to customize URL unfurling for.

• channelstringObligatorio

  Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.

• unfurlsstring

  URL-encoded JSON mapping message URLs to custom unfurl content (Slack attachment format or unfurl blocks). To remove an existing unfurl, provide an empty unfurl block for its URL.

• user_auth_urlstring

  URL-encoded custom URL for user authentication with your app to enable unfurling. Used when `user_auth_required` is true.

• user_auth_messagestring

  Ephemeral message text prompting user authentication with your app for domain-specific unfurling. Used when `user_auth_required` is true and authorization is pending.

• user_auth_requiredboolean

  Set to `true` if user authentication is required to unfurl links for a domain, enabling an authentication flow using `user_auth_url` and `user_auth_message`.

Parámetros de salida

• dataobjectObligatorio

  Contains an `ok` field which indicates if the request to customize unfurling was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstring

  ID of the comment to delete. This can be obtained when the comment is created or by listing file comments.

• filestring

  ID of the file to delete a comment from. The file ID can be obtained using the `files.info` method or when a file is shared.

Parámetros de salida

• dataobjectObligatorio

  Indicates if the comment was successfully deleted.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  ID of the file to delete. Typically obtained when a file is uploaded or listed.

Parámetros de salida

• dataobjectObligatorio

  Outcome of the file deletion request. A successful operation is indicated by an 'ok' field with a true value.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channel_idstringObligatorio

  ID of the channel to be permanently deleted. This channel can be public or private.

Parámetros de salida

• dataobjectObligatorio

  Standard Slack API response object. It includes an `ok` field which is `true` upon successful deletion of the channel.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reminderstring

  The unique identifier of the reminder to be deleted. This ID is obtained when a reminder is created or listed.

Parámetros de salida

• dataobjectObligatorio

  Contains a boolean field `ok` which is true if the reminder was successfully deleted.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• as_userboolean

  Pass `true` to delete the message as the authenticated user (bots are considered authed users here, uses `chat:write:user` scope); if `false` or omitted, deletes as a bot (uses `chat:write:bot` scope).

• channelstringObligatorio

  ID of the channel, private group, or DM conversation where the message is scheduled.

• scheduled_message_idstringObligatorio

  Unique ID (`scheduled_message_id`) of the message to be deleted; obtained from `chat.scheduleMessage` response.

Parámetros de salida

• dataobjectObligatorio

  Standard API response, includes an `ok` field confirming deletion success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsstring

  Timestamp of the message to be deleted. Must be the exact Slack message timestamp string with fractional precision, e.g., '1234567890.123456'.

• as_userboolean

  If `True`, deletes the message as the authenticated user using the `chat:write:user` scope. Bot users are considered authenticated users. If `False` or omitted, the message is deleted using the `chat:write:bot` scope.

• channelstring

  The ID of the channel, private group, or direct message conversation containing the message to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Confirmation details for the message deletion, including the channel ID and the timestamp of the deleted message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tokenstringObligatorio

  Authentication token identifying the user whose profile photo will be deleted.

Parámetros de salida

• dataobjectObligatorio

  Indicates the success of the photo deletion operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usergroupstringObligatorio

  Unique encoded ID of the User Group to disable.

• include_countboolean

  If true, include the number of users in the User Group in the response.

Parámetros de salida

• dataobjectObligatorio

  The response data from the Slack API, containing the outcome and details of the disabled User Group.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usergroupstringObligatorio

  The unique encoded ID of the User Group to enable. This ID typically starts with 'S'.

• include_countboolean

  If true, includes the count of users in the User Group in the response.

Parámetros de salida

• dataobjectObligatorio

  The response payload from the API, detailing the outcome of the enable operation and the User Group's current state.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  The ID of the file to be shared publicly.

Parámetros de salida

• dataobjectObligatorio

  The response data containing the file object and success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the call to be ended, obtained from the `calls.add` method.

• durationinteger

  Duration of the call in seconds.

Parámetros de salida

• dataobjectObligatorio

  Response data from the API call.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The response data indicating the outcome of the action.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• botstring

  The ID of the bot user to retrieve information for. This typically starts with 'B'.

Parámetros de salida

• dataobjectObligatorio

  The main data object in the response, containing the bot information and success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of messages to return per page (1-1000). Fewer may be returned if at the end of history or channel has fewer messages.

• cursorstring

  Pagination cursor from `next_cursor` of a previous response to fetch subsequent pages. See Slack's pagination documentation for details.

• lateststring

  End of the time range of messages to include in results. Accepts a Unix timestamp or a Slack timestamp (e.g., '1234567890.000000').

• oldeststring

  Start of the time range of messages to include in results. Accepts a Unix timestamp or a Slack timestamp (e.g., '1234567890.000000').

• channelstringObligatorio

  The ID of the public channel, private channel, direct message, or multi-person direct message to fetch history from.

• inclusiveboolean

  Include messages with `latest` or `oldest` timestamps in the results; applies only when `latest` or `oldest` is specified.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API, containing messages and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamstring

  The ID of the team to retrieve information for. If omitted, information for the current team (associated with the authentication token) is returned. The token must have permissions to view the specified team, especially for teams accessible via external shared channels.

Parámetros de salida

• dataobjectObligatorio

  Response containing team information

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstringObligatorio

  Comma-separated list of users to fetch Do Not Disturb status for

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  File ID. Use instead of channel/timestamp or file comment ID.

• fullboolean

  If true, returns the complete list of users for each reaction.

• channelstring

  Channel ID. Required if `timestamp` is provided and no file or file comment ID is given.

• timestampstring

  Message timestamp (e.g., '1234567890.123456'). Required if `channel` is provided and no file or file comment ID is given.

• file_commentstring

  File comment ID. Use instead of channel/timestamp or file ID.

Parámetros de salida

• dataarrayObligatorio

  Contains the requested item (message, file, or file comment) and its reactions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsstring

  Timestamp of the parent message in the thread. Must be an existing message. If no replies, only the parent message itself is returned.

• limitinteger

  Maximum number of messages to return. Fewer may be returned even if more are available.

• cursorstring

  Pagination cursor from `response_metadata.next_cursor` of a previous response to get subsequent pages. If omitted, fetches the first page.

• lateststring

  Latest message timestamp in the time range to include results.

• oldeststring

  Oldest message timestamp in the time range to include results.

• channelstring

  ID of the conversation (channel, direct message, etc.) to fetch the thread from.

• inclusiveboolean

  Whether to include messages with `latest` or `oldest` timestamps in results. Effective only if `latest` or `oldest` is specified.

Parámetros de salida

• dataobjectObligatorio

  The response data containing the message thread and pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamstring

  The ID of the team to retrieve information for. If omitted, information for the current team (associated with the authentication token) is returned. The token must have permissions to view the specified team, especially for teams accessible via external shared channels.

Parámetros de salida

• dataobjectObligatorio

  Response containing team information

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  The unique identifier of the Slack team (workspace) for which to fetch settings. This ID typically starts with 'T'.

Parámetros de salida

• dataobjectObligatorio

  The response payload containing the workspace settings information. It includes a success status (`ok`) and dynamically populated fields representing the various settings of the team (e.g., team name, domain, icon).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of channels to return (1 to 200). Defaults to 50.

• typesstring

  Comma-separated list of channel types to include: `public_channel`, `private_channel`, `mpim` (multi-person direct message), `im` (direct message). Defaults to public and private channels.

• exact_matchboolean

  Use exact matching instead of partial matching. Defaults to false.

• member_onlyboolean

  Only return channels the user is a member of. Defaults to false.

• search_querystringObligatorio

  Search query to find channels. Searches across channel name, topic, purpose, and description (case-insensitive partial matching).

• exclude_archivedboolean

  Exclude archived channels from search results. Defaults to true.

Parámetros de salida

• dataobjectObligatorio

  Response containing the list of matching channels and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of the user to look up.

Parámetros de salida

• dataobjectObligatorio

  The API response payload. On success, this includes an 'ok' status and the 'user' object containing detailed information about the found user.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of users to return (1 to 200). Defaults to 50.

• exact_matchboolean

  Use exact matching instead of partial matching. Defaults to false.

• include_botsboolean

  Include bot users in search results. Defaults to false.

• search_querystringObligatorio

  Search query to find users. Searches across name, display name, real name, email address, first name, last name, and status text (case-insensitive partial matching). For exact email matches with exact_match=true, uses Slack's efficient email lookup endpoint.

• include_deletedboolean

  Include deleted/deactivated users in search results. Defaults to false.

• include_restrictedboolean

  Include restricted (guest) users in search results. Defaults to true.

Parámetros de salida

• dataobjectObligatorio

  Response containing the list of matching users and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channel_idstringObligatorio

  Identifier of the channel for which to retrieve conversation preferences.

Parámetros de salida

• dataobjectObligatorio

  Response data with the channel's conversation preferences.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reminderstring

  The unique identifier of the reminder to retrieve information for. This ID typically starts with 'Rm'.

Parámetros de salida

• dataobjectObligatorio

  The response payload containing the status of the request and the detailed reminder information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  Specify a file by providing its ID.

• external_idstring

  Creator defined GUID for the file.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstringObligatorio

  Comma-separated list of users to fetch Do Not Disturb status for

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  The ID of the user to query for presence information. This is a string identifier, typically starting with 'U' or 'W' (e.g., 'U123ABC456'). If not provided, presence information for the authenticated user will be returned.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed presence information for the requested user, including their current status, connection details, and activity timestamps.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the public or private channel to create

• team_idstring

  encoded team id to create the channel in, required if org token is used

• is_privateboolean

  Create a private channel instead of a public one

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstring

  Comma-separated string of valid Slack User IDs to invite. Up to 1000 user IDs can be included.

• channelstring

  ID of the public or private Slack channel to invite users to; must be an existing channel. Typically starts with 'C' (public) or 'G' (private/group).

Parámetros de salida

• dataobjectObligatorio

  Response data detailing the channel after invitations and an 'ok' status for success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idsstringObligatorio

  A comma-separated string of Slack User IDs to invite to the channel. Up to 1000 users can be specified.

• channel_idstringObligatorio

  The ID of the public or private Slack channel to which users will be invited.

Parámetros de salida

• dataobjectObligatorio

  Contains the status of the user invitation operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of the person to be invited to the workspace.

• resendboolean

  If true, allows this invitation to be resent if the user hasn't signed up. Defaults to false.

• team_idstringObligatorio

  The ID of the Slack workspace (e.g., T123ABCDEFG) where the user will be invited.

• real_namestring

  The full name of the user being invited.

• channel_idsstringObligatorio

  A comma-separated list of channel IDs (e.g., C1234567890,C0987654321) for the user to join. At least one channel ID must be provided.

• is_restrictedboolean

  Specifies if the invited user should be a multi-channel guest. Defaults to false. Multi-channel guests can access only the channels they are invited to, plus any public channels.

• custom_messagestring

  Custom message to include in the invitation email.

• guest_expiration_tsstring

  Unix timestamp for guest account expiration; provide only if inviting a guest user and an expiration date is desired.

• is_ultra_restrictedboolean

  Specifies if the invited user should be a single-channel guest (also known as an ultra-restricted guest). Defaults to false. Single-channel guests can only access one channel (plus DMs and Huddles).

Parámetros de salida

• dataobjectObligatorio

  Response data for the user invitation process

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  The email address of the person to be invited to the workspace.

• resendboolean

  If true, allows this invitation to be resent if the user hasn't signed up. Defaults to false.

• team_idstringObligatorio

  The ID of the Slack workspace (e.g., T123ABCDEFG) where the user will be invited.

• real_namestring

  The full name of the user being invited.

• channel_idsstringObligatorio

  A comma-separated list of channel IDs (e.g., C1234567890,C0987654321) for the user to join. At least one channel ID must be provided.

• is_restrictedboolean

  Specifies if the invited user should be a multi-channel guest. Defaults to false. Multi-channel guests can access only the channels they are invited to, plus any public channels.

• custom_messagestring

  Custom message to include in the invitation email.

• guest_expiration_tsstring

  Unix timestamp for guest account expiration; provide only if inviting a guest user and an expiration date is desired.

• is_ultra_restrictedboolean

  Specifies if the invited user should be a single-channel guest (also known as an ultra-restricted guest). Defaults to false. Single-channel guests can only access one channel (plus DMs and Huddles).

Parámetros de salida

• dataobjectObligatorio

  Response data for the user invitation process

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  ID of the Slack conversation (public channel, private channel, or multi-person direct message) to join.

Parámetros de salida

• dataobjectObligatorio

  Contains the outcome of the join operation, including details of the channel if the join was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  ID of the conversation to leave (e.g., C1234567890). Despite `default=None` in the schema, this ID is functionally required by the Slack API.

Parámetros de salida

• dataobjectObligatorio

  Detailed outcome of the leave attempt, including context on the user's channel membership status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  The ID of the user whose conversations will be listed. If not provided, conversations for the authenticated user are returned. Non-public channels are restricted to those where the calling user (authenticating user) shares membership.

• limitinteger

  The maximum number of items to return per page. Must be an integer, typically between 1 and 1000 (e.g., 100). If omitted, the API's default limit (often 100) applies. Fewer items than the limit may be returned.

• typesstring

  A comma-separated list of conversation types to include. Valid types are `public_channel`, `private_channel`, `mpim` (multi-person direct message), and `im` (direct message). If omitted, all types are included.

• cursorstring

  Pagination cursor for retrieving the next set of results. Obtain this from the `next_cursor` field in a previous response's `response_metadata`. If omitted, the first page is fetched.

• exclude_archivedboolean

  Set to `true` to exclude archived channels from the list. If `false` or omitted, archived channels are typically included (the API's default behavior for omission will apply, usually including them).

Parámetros de salida

• dataobjectObligatorio

  The primary response data, including the list of conversations and pagination cursors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of channels to return per page (1 to 1000). Fewer channels may be returned than requested. This schema defaults to 1 if omitted.

• typesstring

  Comma-separated list of channel types to include: `public_channel`, `private_channel`, `mpim` (multi-person direct message), `im` (direct message). The API defaults to `public_channel` if this parameter is omitted.

• cursorstring

  Pagination cursor (from a previous response's `next_cursor`) for the next page of results. Omit for the first page.

• channel_namestring

  Filter channels by name (case-insensitive substring match). This is a client-side filter applied after fetching from the API.

• exclude_archivedboolean

  Excludes archived channels if true. The API defaults to false (archived channels are included).

Parámetros de salida

• dataobjectObligatorio

  Response containing the list of Slack channels with pagination information and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of channels to return per page (1 to 1000). Fewer channels may be returned than requested. This schema defaults to 1 if omitted.

• typesstring

  Comma-separated list of channel types to include: `public_channel`, `private_channel`, `mpim` (multi-person direct message), `im` (direct message). The API defaults to `public_channel` if this parameter is omitted.

• cursorstring

  Pagination cursor (from a previous response's `next_cursor`) for the next page of results. Omit for the first page.

• channel_namestring

  Filter channels by name (case-insensitive substring match). This is a client-side filter applied after fetching from the API.

• exclude_archivedboolean

  Excludes archived channels if true. The API defaults to false (archived channels are included).

Parámetros de salida

• dataobjectObligatorio

  Response containing the list of Slack channels with pagination information and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of items to return per page; fewer may be returned if the end of the list is reached. Recommended to set a value (e.g., 100) as Slack may error for large workspaces if omitted.

• cursorstring

  Pagination cursor for fetching subsequent pages. Set to `next_cursor` from a previous response's `response_metadata`. Omit for the first page.

• include_localeboolean

  Include the `locale` field for each user. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Main data payload, including users list and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of items to return per page; fewer may be returned if the end of the list is reached. Recommended to set a value (e.g., 100) as Slack may error for large workspaces if omitted.

• cursorstring

  Pagination cursor for fetching subsequent pages. Set to `next_cursor` from a previous response's `response_metadata`. Omit for the first page.

• include_localeboolean

  Include the `locale` field for each user. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Main data payload, including users list and metadata

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usergroupstringObligatorio

  The encoded ID of the User Group to list users from. This ID is an alphanumeric string.

• include_disabledboolean

  Set to `true` to include users from disabled user groups. If omitted, the default Slack API behavior for handling disabled groups (typically excluding them) will apply.

Parámetros de salida

• dataobjectObligatorio

  The response data, indicating success and containing the list of user IDs in the specified user group.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  The ID of the user whose conversations will be listed. If not provided, conversations for the authenticated user are returned. Non-public channels are restricted to those where the calling user (authenticating user) shares membership.

• limitinteger

  The maximum number of items to return per page. Must be an integer, typically between 1 and 1000 (e.g., 100). If omitted, the API's default limit (often 100) applies. Fewer items than the limit may be returned.

• typesstring

  A comma-separated list of conversation types to include. Valid types are `public_channel`, `private_channel`, `mpim` (multi-person direct message), and `im` (direct message). If omitted, all types are included.

• cursorstring

  Pagination cursor for retrieving the next set of results. Obtain this from the `next_cursor` field in a previous response's `response_metadata`. If omitted, the first page is fetched.

• exclude_archivedboolean

  Set to `true` to exclude archived channels from the list. If `false` or omitted, archived channels are typically included (the API's default behavior for omission will apply, usually including them).

Parámetros de salida

• dataobjectObligatorio

  The primary response data, including the list of conversations and pagination cursors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pagestring

  Specifies the page number of the results to retrieve when paginating. Default is 1.

• userstring

  Filter files created by a single user. Provide the Slack User ID.

• countstring

  Specifies the number of files to return per page. Default is 100, maximum is 1000.

• ts_tointeger

  Filter files created before this Unix timestamp (inclusive).

• typesstring

  Filter files by types (comma-separated: 'images,pdfs'). Default 'all' for all types. Common: `all`, `spaces` (posts), `snippets`, `images`, `gdocs`, `zips`, `pdfs`.

• channelstring

  Filter files appearing in a specific channel, indicated by its Slack Channel ID.

• ts_frominteger

  Filter files created after this Unix timestamp (inclusive).

• show_files_hidden_by_limitboolean

  Show truncated file info for files hidden due to being too old or if the team owning the file is over the storage limit.

Parámetros de salida

• dataobjectObligatorio

  The response schema containing the list of files and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The primary response data, including the operation's success status and the list of reminders.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The maximum number of items to return.

• ts_tonumber

  Filter files created before this timestamp (inclusive).

• cursorstring

  Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail.

• channelstring

  Filter files appearing in a specific channel, indicated by its ID.

• ts_fromnumber

  Filter files created after this timestamp (inclusive).

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum messages per page (1-1000). Defaults to 100.

• cursorstring

  Pagination cursor from `response_metadata.next_cursor` of a previous response. Omit for the first page.

• lateststring

  Latest UNIX timestamp (exclusive) for messages. Defaults to the current time if omitted.

• oldeststring

  Earliest UNIX timestamp (inclusive) for messages. Defaults to 0 if omitted.

• channelstring

  ID or name of the channel (public, private, or DM) to list messages for. If omitted, lists for all accessible channels in the workspace.

Parámetros de salida

• dataobjectObligatorio

  Response payload with scheduled messages and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum messages per page (1-1000). Defaults to 100.

• cursorstring

  Pagination cursor from `response_metadata.next_cursor` of a previous response. Omit for the first page.

• lateststring

  Latest UNIX timestamp (exclusive) for messages. Defaults to the current time if omitted.

• oldeststring

  Earliest UNIX timestamp (inclusive) for messages. Defaults to 0 if omitted.

• channelstring

  ID or name of the channel (public, private, or DM) to list messages for. If omitted, lists for all accessible channels in the workspace.

Parámetros de salida

• dataobjectObligatorio

  Response payload with scheduled messages and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  The ID of the channel to retrieve pinned items from. This can be a public channel ID, private group ID, or direct message channel ID.

Parámetros de salida

• dataarrayObligatorio

  The structured response from the API. This is a list that usually contains one element: either a collection of pinned items or a count object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The maximum number of items to return.

• ts_tonumber

  Filter files created before this timestamp (inclusive).

• cursorstring

  Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail.

• channelstring

  Filter files appearing in a specific channel, indicated by its ID.

• ts_fromnumber

  Filter files created after this timestamp (inclusive).

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results to return.

• countinteger

  Number of items to return per page.

• limitinteger

  The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

• cursorstring

  Parameter for pagination. Set cursor to the next_cursor attribute returned by the previous request's response_metadata.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results to return.

• countinteger

  Number of items to return per page.

• limitinteger

  The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

• cursorstring

  Parameter for pagination. Set cursor to the next_cursor attribute returned by the previous request's response_metadata.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The core response data from Slack. If `ok` (within this data structure) is `True`, includes an `emoji` dictionary (custom emoji names to image URLs or aliases) and may contain other fields like `cache_ts`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• include_countboolean

  Include the number of users in each user group. Defaults to false.

• include_usersboolean

  Include the list of user IDs for each user group. Defaults to false.

• include_disabledboolean

  Include disabled user groups in the results. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Contains the API response data, including a list of user groups if the request was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• fullboolean

  If true, return the complete reaction list, which may include reactions to deleted items.

• pageinteger

  Page number of results to return.

• userstring

  Reactions made by this user. Defaults to the authed user.

• countinteger

  Number of items to return per page.

• limitinteger

  Maximum number of items to return; fewer items may be returned. Use with cursor-based pagination.

• cursorstring

  Pagination cursor. Set to `next_cursor` from a previous response's `response_metadata`. See Slack API pagination documentation for details.

Parámetros de salida

• dataobjectObligatorio

  Response data including the list of reactions and pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  The primary response data, including the operation's success status and the list of reminders.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The maximum number of admin users to retrieve per page. Must be a positive integer. If not specified, a default limit set by Slack will apply.

• cursorstring

  Pagination cursor for retrieving the next page of results. Pass the `next_cursor` value returned from a previous request to fetch subsequent items. If omitted, the first page is retrieved.

• team_idstringObligatorio

  The ID of the Slack workspace (e.g., `T123456789`) from which to list admin users.

Parámetros de salida

• dataobjectObligatorio

  If the request was successful (`ok` is true), contains the list of admin users for the workspace. Each user object typically includes details like user ID, name, and email.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• presencestringObligatorio

  The presence state to set for the user. Valid values are 'auto' (Slack determines presence based on activity) or 'away' (sets presence to away).

Parámetros de salida

• dataobjectObligatorio

  Contains the outcome of the presence update request, typically indicating success with an 'ok: true' field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reminderstring

  The unique identifier of the Slack reminder to be marked as complete. This ID is typically obtained when a reminder is created or listed.

Parámetros de salida

• dataobjectObligatorio

  Indicates the outcome of the operation. Contains an 'ok' field which is 'True' if the reminder was successfully marked as complete.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstring

  Comma-separated list of user IDs (1 for a DM, or 2-8 for an MPIM) to open/resume a conversation. Order is preserved for MPIMs. Do not use if `channel` is provided.

• channelstring

  ID or name of an existing DM or MPIM channel to open/resume. Do not use if `users` is provided.

• return_imboolean

  If `true`, returns the full DM channel object. Applies only when opening a DM via a single user ID in `users` (not with `channel`).

Parámetros de salida

• dataobjectObligatorio

  Details of the opened or resumed conversation, including channel information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstring

  Comma-separated list of user IDs (1 for a DM, or 2-8 for an MPIM) to open/resume a conversation. Order is preserved for MPIMs. Do not use if `channel` is provided.

• channelstring

  ID or name of an existing DM or MPIM channel to open/resume. Do not use if `users` is provided.

• return_imboolean

  If `true`, returns the full DM channel object. Applies only when opening a DM via a single user ID in `users` (not with `channel`).

Parámetros de salida

• dataobjectObligatorio

  Details of the opened or resumed conversation, including channel information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  The ID of the channel where the message will be pinned.

• timestampstring

  Timestamp of the message to pin, in 'epoch_time.microseconds' format (e.g., '1624464000.000200'). If not provided, the most recent message in the channel will be pinned.

Parámetros de salida

• dataobjectObligatorio

  Indicates the outcome of the pin operation, typically confirming success with an 'ok: true' field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  ID of the call returned by the add method.

• usersstringObligatorio

  The list of users to remove as participants in the call. users is a JSON array with each user having a `slack_id` or `external_id`.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  The name or title for the call. This will be displayed in Slack to identify the call.

• usersstring

  A JSON string representing an array of user objects to be registered as participants in the call. Each user object in the array should define a participant using their `slack_id` (Slack User ID) and/or an `external_id` (an identifier from the third-party application, unique to that user within that application). For instance: `'''[{"slack_id": "U012A3BCD4E"}, {"external_id": "user-xyz@example.com", "slack_id": "U012A3BCD4F"}]'''`.

• join_urlstringObligatorio

  The URL required for a client to join the call (e.g., a web join link). This field is mandatory.

• created_bystring

  Slack user ID of the creator; optional (defaults to authenticated user) if using a user token, otherwise required.

• date_startinteger

  The start time of the call, specified as a UTC UNIX timestamp in seconds. For example, `1678886400` corresponds to March 15, 2023, at 12:00 PM UTC.

• external_unique_idstringObligatorio

  A unique identifier for the call, supplied by the third-party call provider. This ID must be unique across all calls from that specific service. This field is required.

• external_display_idstring

  An optional, human-readable identifier for the call, supplied by the third-party call provider. If provided, this ID will be displayed in the Slack call object interface.

• desktop_app_join_urlstring

  An optional URL that, when provided, allows Slack clients to attempt to directly launch the third-party call application. This is typically a deep link URI for the specific application.

Parámetros de salida

• dataobjectObligatorio

  Wrapper for the API response. The `ok` field confirms successful call registration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  ID of the call returned by the add method.

• usersstringObligatorio

  The list of users to add as participants in the call. users is a JSON array (formatted as a string) containing information for each user. Each element should include both a `slack_id` and optionally an `external_id`. For example: `[{"slack_id": "U1H77", "external_id": "ext-id"}]`.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  Slack-specific file ID.

• tokenstring

  Authentication token.

• external_idstring

  Creator-defined, globally unique ID (GUID) for the file.

Parámetros de salida

• dataobjectObligatorio

  Standard API response; includes `ok: true` on successful removal.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  ID of the file to unstar.

• channelstring

  ID of the item (channel, private group, DM) or the message's channel (if `timestamp` is also provided).

• timestampstring

  Timestamp of the message to unstar; requires `channel`.

• file_commentstring

  ID of the file comment to unstar.

Parámetros de salida

• dataobjectObligatorio

  Indicates success with an `ok: true` field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  The ID of the user to be removed from the conversation.

• channelstring

  ID of the conversation (channel) to remove the user from.

Parámetros de salida

• dataobjectObligatorio

  Wrapper for the response data, which includes an 'ok' field. A value of 'true' for 'ok' indicates the user was successfully removed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  ID of the call returned by the add method.

• usersstringObligatorio

  The list of users to remove as participants in the call. users is a JSON array with each user having a `slack_id` or `external_id`.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  ID of the file to remove the reaction from.

• namestringObligatorio

  Name of the emoji reaction to remove (e.g., 'thumbsup'), without colons.

• channelstring

  Channel ID of the message. Required if `timestamp` is provided.

• timestampstring

  Timestamp of the message. Required if `channel` is provided.

• file_commentstring

  ID of the file comment to remove the reaction from.

Parámetros de salida

• dataobjectObligatorio

  API response indicating success via an `ok` field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The new name for the channel. Channel names can be up to 80 characters long and may include lowercase letters, numbers, hyphens, and underscores. They cannot contain spaces or periods.

• channel_idstringObligatorio

  The ID of the channel to rename.

Parámetros de salida

• dataobjectObligatorio

  The response schema indicating if the operation was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  New name for the conversation. Must be 80 characters or less and contain only lowercase letters, numbers, hyphens, and underscores.

• channelstring

  ID of the conversation (channel) to rename.

Parámetros de salida

• dataobjectObligatorio

  The response schema containing the updated channel information and a success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Current name of the custom emoji to be renamed. Colons (e.g., `:current_emoji:`) are optional.

• tokenstringObligatorio

  Authentication token.

• new_namestringObligatorio

  Desired new name for the custom emoji. Must be unique within the workspace and adhere to Slack's emoji naming conventions.

Parámetros de salida

• dataobjectObligatorio

  Indicates the success of the emoji rename operation with an 'ok' flag.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataarrayObligatorio

  User and team identity data; specific fields depend on granted OAuth scopes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the Slack call for which to retrieve information. This ID is typically returned when a call is initiated (e.g., by the `calls.add` method).

Parámetros de salida

• dataobjectObligatorio

  Contains the API response. This object includes an `ok` field indicating success, and other dynamic fields representing the detailed information of the retrieved call (e.g., participants, duration, status) due to `extra='allow'` in its schema.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  The ID of the conversation (channel, direct message, or multi-person direct message) to retrieve information for.

• include_localeboolean

  If true, the response will include the locale setting for the conversation. Defaults to false.

• include_num_membersboolean

  If true, the response will include the number of members in the conversation. Defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed information for the requested conversation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The maximum number of members to return per page. Fewer items may be returned than the requested limit, even if more members exist and the end of the list hasn't been reached.

• cursorstring

  Pagination cursor value for fetching specific pages of results. To retrieve the next page, provide the `next_cursor` value obtained from the `response_metadata` of the previous API call. If omitted or empty, the first page of members is fetched. For more details on pagination, refer to Slack API documentation.

• channelstring

  ID of the conversation (public channel, private channel, direct message, or multi-person direct message) for which to retrieve the member list. Public channel IDs typically start with 'C', private channels or multi-person direct messages (MPIMs) with 'G', and direct messages (DMs) with 'D'.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API, containing the list of conversation members and pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  User ID to fetch DND status for. If not provided, fetches the DND status for the authenticated user.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed Do Not Disturb (DND) status information for the user, including DND and snooze states, and relevant timestamps.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  ID of the file to retrieve information for. This is a required field.

• pagestring

  Page number of comment results to retrieve. Expects a string representing an integer (e.g., '2'). Used for comment pagination. Slack's default is 1 if not provided. `cursor`-based pagination is generally preferred.

• countstring

  Number of comments to retrieve per page. Expects a string representing an integer (e.g., '20'). Used for comment pagination. Slack's default is 100 if not provided.

• limitinteger

  The maximum number of comments to retrieve. This is an upper limit, not a guarantee of how many will be returned. Primarily used for comment pagination.

• cursorstring

  Pagination cursor for retrieving comments. Set to `next_cursor` from a previous response's `response_metadata` to fetch the next page of comments. Essential for navigating through large sets of comments. See [pagination](https://slack.dev) for more details.

Parámetros de salida

• dataobjectObligatorio

  Core response data, including the file object, comments, and related information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  The ID of the user to retrieve information for.

• include_localeboolean

  Set to `true` to include the user's locale (e.g., `en-US`) in the response. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed information for the requested user, including profile, status, and team data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  The ID of the conversation or channel containing the message. This can be a public channel ID, a private channel ID, a direct message channel ID, or a multi-person direct message channel ID.

• message_tsstringObligatorio

  A message's `ts` value (timestamp), uniquely identifying it within a channel. Example: '1610144875.000600'.

Parámetros de salida

• dataobjectObligatorio

  The response schema containing the permalink and channel information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  Specify a file by providing its ID.

• external_idstring

  Creator defined GUID for the file.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• visibilitystring

  Filters profile fields by visibility. Use 'all' for all fields (default if unspecified), 'visible' for fields where 'is_hidden' is false/unset, or 'hidden' for fields where 'is_hidden' is true.

Parámetros de salida

• dataobjectObligatorio

  Successfully retrieved team profile details, including all field definitions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userstring

  User ID to retrieve profile information for; defaults to the authenticated user.

• include_labelsboolean

  Include human-readable labels for custom profile fields. API defaults to false.

Parámetros de salida

• dataobjectObligatorio

  Contains the API call's success status and the requested user's profile information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  ID of conversation to unarchive

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  The ID of the file for which to revoke the public URL. This unique identifier typically starts with 'F'.

Parámetros de salida

• dataobjectObligatorio

  Contains the updated file object reflecting the new sharing status and an 'ok' field indicating the success of the operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  This sends raw text only, use markdown_text field for formatting. Primary text of the message; formatting with `mrkdwn` applies. Required if `blocks` and `attachments` are not provided.

• parsestring

  Message text treatment: `full` for special formatting, `none` otherwise (default). See Slack's `chat.postMessage` docs for options.

• blocksstring

  **DEPRECATED**: Use `markdown_text` field instead. JSON array of structured blocks as a URL-encoded string for message layout and design. Required if `text` and `attachments` are not provided.

• as_userboolean

  Post as the authenticated user, not a bot. Defaults to false. See Slack's `chat.postMessage` docs for authorship.

• channelstring

  Channel, private group, or DM channel ID (e.g., C1234567890) or name (e.g., #general) to send the message to.

• post_atstring

  Unix EPOCH timestamp (integer seconds since 1970-01-01 00:00:00 UTC) for the future message send time.

• thread_tsstring

  Timestamp of the parent message for the scheduled message to be a thread reply. Must be float seconds (e.g., `1234567890.123456`).

• link_namesboolean

  Pass true to automatically link channel names (e.g., #general) and usernames (e.g., @user).

• attachmentsstring

  JSON array of structured attachments as a URL-encoded string for rich content. Required if `text` and `blocks` are not provided.

• unfurl_linksboolean

  Pass false to disable automatic link unfurling. Defaults to true.

• unfurl_mediaboolean

  Pass false to disable automatic media unfurling. Defaults to true.

• markdown_textstring

  **PREFERRED**: Write your scheduled message in markdown for nicely formatted display. Supports headers (#), bold (**text**), italic (*text*), strikethrough (~~text~~), code (```), links ([text](url)), quotes (>), and dividers (---). Your message will be posted with beautiful formatting.

• reply_broadcastboolean

  With `thread_ts`, makes reply visible to all in channel, not just thread members. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Details of the successfully scheduled message

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  This sends raw text only, use markdown_text field for formatting. Primary text of the message; formatting with `mrkdwn` applies. Required if `blocks` and `attachments` are not provided.

• parsestring

  Message text treatment: `full` for special formatting, `none` otherwise (default). See Slack's `chat.postMessage` docs for options.

• blocksstring

  **DEPRECATED**: Use `markdown_text` field instead. JSON array of structured blocks as a URL-encoded string for message layout and design. Required if `text` and `attachments` are not provided.

• as_userboolean

  Post as the authenticated user, not a bot. Defaults to false. See Slack's `chat.postMessage` docs for authorship.

• channelstring

  Channel, private group, or DM channel ID (e.g., C1234567890) or name (e.g., #general) to send the message to.

• post_atstring

  Unix EPOCH timestamp (integer seconds since 1970-01-01 00:00:00 UTC) for the future message send time.

• thread_tsstring

  Timestamp of the parent message for the scheduled message to be a thread reply. Must be float seconds (e.g., `1234567890.123456`).

• link_namesboolean

  Pass true to automatically link channel names (e.g., #general) and usernames (e.g., @user).

• attachmentsstring

  JSON array of structured attachments as a URL-encoded string for rich content. Required if `text` and `blocks` are not provided.

• unfurl_linksboolean

  Pass false to disable automatic link unfurling. Defaults to true.

• unfurl_mediaboolean

  Pass false to disable automatic media unfurling. Defaults to true.

• markdown_textstring

  **PREFERRED**: Write your scheduled message in markdown for nicely formatted display. Supports headers (#), bold (**text**), italic (*text*), strikethrough (~~text~~), code (```), links ([text](url)), quotes (>), and dividers (---). Your message will be posted with beautiful formatting.

• reply_broadcastboolean

  With `thread_ts`, makes reply visible to all in channel, not just thread members. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Details of the successfully scheduled message

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results to return.

• sortstring

  Sort results by `score` (relevance) or `timestamp` (chronological).

• countinteger

  Number of messages to return per page. Maximum value is 100.

• querystringObligatorio

  Search query, supporting modifiers like `in:#channel-name`, `from:@user-name`, `has::star:`, or `before:YYYY-MM-DD`.

• sort_dirstring

  Sort direction: `asc` (ascending) or `desc` (descending).

• highlightboolean

  Enable highlighting of search terms in results.

Parámetros de salida

• dataobjectObligatorio

  Contains search results and related information, such as `messages` and `pagination_info`; its structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results to return.

• sortstring

  Sort results by `score` (relevance) or `timestamp` (chronological).

• countinteger

  Number of messages to return per page. Maximum value is 100.

• querystringObligatorio

  Search query, supporting modifiers like `in:#channel-name`, `from:@user-name`, `has::star:`, or `before:YYYY-MM-DD`.

• sort_dirstring

  Sort direction: `asc` (ascending) or `desc` (descending).

• highlightboolean

  Enable highlighting of search terms in results.

Parámetros de salida

• dataobjectObligatorio

  Contains search results and related information, such as `messages` and `pagination_info`; its structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

• userstringObligatorio

  User ID of the user to send the ephemeral message to.

• parsestring

  Change how messages are treated. Defaults to none. See below.

• blocksstring

  A JSON-based array of structured blocks, presented as a URL-encoded string.

• as_userboolean

  Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.

• channelstringObligatorio

  Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.

• icon_urlstring

  URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• usernamestring

  Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• thread_tsstring

  Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

• icon_emojistring

  Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• link_namesboolean

  Find and link channel names and usernames.

• attachmentsstring

  A JSON-based array of structured attachments, presented as a URL-encoded string.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  DEPRECATED: This sends raw text only, use markdown_text field. Primary textual content. Recommended fallback if using `blocks` or `attachments`. Supports mrkdwn unless `mrkdwn` is `false`.

• parsestring

  Message text parsing behavior. Default `none` (no special parsing). `full` parses as user-typed (links @mentions, #channels). See Slack API docs for details.

• blocksstring

  DEPRECATED: Use `markdown_text` field instead. URL-encoded JSON array of layout blocks for rich/interactive messages. See Slack API Block Kit docs for structure.

• mrkdwnboolean

  Disable Slack's markdown for `text` field if `false`. Default `true` (allows *bold*, _italic_, etc.).

• as_userboolean

  Post as the authenticated user instead of as a bot. Defaults to `false`. If `true`, `username`, `icon_emoji`, and `icon_url` are ignored. If `false`, the message is posted as a bot, allowing appearance customization.

• channelstringObligatorio

  ID or name of the channel, private group, or IM channel to send the message to.

• icon_urlstring

  Image URL for bot's icon (must be HTTPS). Applies if `as_user` is `false`.

• usernamestring

  Bot's name in Slack (max 80 chars). Applies if `as_user` is `false`.

• thread_tsstring

  Timestamp (`ts`) of an existing message to make this a threaded reply. Use `ts` of the parent message, not another reply. Example: '1476746824.000004'.

• icon_emojistring

  Emoji for bot's icon (e.g., ':robot_face:'). Overrides `icon_url`. Applies if `as_user` is `false`.

• link_namesboolean

  Automatically hyperlink channel names (e.g., #channel) and usernames (e.g., @user) in message text. Defaults to `false` for bot messages.

• attachmentsstring

  URL-encoded JSON array of message attachments, a legacy method for rich content. See Slack API documentation for structure.

• unfurl_linksboolean

  Enable unfurling of text-based URLs. Defaults `false` for bots, `true` if `as_user` is `true`.

• unfurl_mediaboolean

  Disable unfurling of media content from URLs if `false`. Defaults to `true`.

• markdown_textstring

  PREFERRED: Write your message in markdown for nicely formatted display. Supports: headers (# ## ###), bold (**text** or __text__), italic (*text* or _text_), strikethrough (~~text~~), inline code (`code`), code blocks (```), links ([text](url)), block quotes (>), lists (- item, 1. item), dividers (--- or ***), context blocks (:::context with images), and section buttons (:::section-button). IMPORTANT: Use \n for line breaks (e.g., 'Line 1\nLine 2'), not actual newlines. USER MENTIONS: To tag users, use their user ID with <@USER_ID> format (e.g., <@U1234567890>), not username.

• reply_broadcastboolean

  If `true` for a threaded reply, also posts to main channel. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Contains the posted message details including the message object and metadata like channel ID and timestamp.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  DEPRECATED: This sends raw text only, use markdown_text field. Primary textual content. Recommended fallback if using `blocks` or `attachments`. Supports mrkdwn unless `mrkdwn` is `false`.

• parsestring

  Message text parsing behavior. Default `none` (no special parsing). `full` parses as user-typed (links @mentions, #channels). See Slack API docs for details.

• blocksstring

  DEPRECATED: Use `markdown_text` field instead. URL-encoded JSON array of layout blocks for rich/interactive messages. See Slack API Block Kit docs for structure.

• mrkdwnboolean

  Disable Slack's markdown for `text` field if `false`. Default `true` (allows *bold*, _italic_, etc.).

• as_userboolean

  Post as the authenticated user instead of as a bot. Defaults to `false`. If `true`, `username`, `icon_emoji`, and `icon_url` are ignored. If `false`, the message is posted as a bot, allowing appearance customization.

• channelstringObligatorio

  ID or name of the channel, private group, or IM channel to send the message to.

• icon_urlstring

  Image URL for bot's icon (must be HTTPS). Applies if `as_user` is `false`.

• usernamestring

  Bot's name in Slack (max 80 chars). Applies if `as_user` is `false`.

• thread_tsstring

  Timestamp (`ts`) of an existing message to make this a threaded reply. Use `ts` of the parent message, not another reply. Example: '1476746824.000004'.

• icon_emojistring

  Emoji for bot's icon (e.g., ':robot_face:'). Overrides `icon_url`. Applies if `as_user` is `false`.

• link_namesboolean

  Automatically hyperlink channel names (e.g., #channel) and usernames (e.g., @user) in message text. Defaults to `false` for bot messages.

• attachmentsstring

  URL-encoded JSON array of message attachments, a legacy method for rich content. See Slack API documentation for structure.

• unfurl_linksboolean

  Enable unfurling of text-based URLs. Defaults `false` for bots, `true` if `as_user` is `true`.

• unfurl_mediaboolean

  Disable unfurling of media content from URLs if `false`. Defaults to `true`.

• markdown_textstring

  PREFERRED: Write your message in markdown for nicely formatted display. Supports: headers (# ## ###), bold (**text** or __text__), italic (*text* or _text_), strikethrough (~~text~~), inline code (`code`), code blocks (```), links ([text](url)), block quotes (>), lists (- item, 1. item), dividers (--- or ***), context blocks (:::context with images), and section buttons (:::section-button). IMPORTANT: Use \n for line breaks (e.g., 'Line 1\nLine 2'), not actual newlines. USER MENTIONS: To tag users, use their user ID with <@USER_ID> format (e.g., <@U1234567890>), not username.

• reply_broadcastboolean

  If `true` for a threaded reply, also posts to main channel. Defaults to `false`.

Parámetros de salida

• dataobjectObligatorio

  Contains the posted message details including the message object and metadata like channel ID and timestamp.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

• userstringObligatorio

  User ID of the user to send the ephemeral message to.

• parsestring

  Change how messages are treated. Defaults to none. See below.

• blocksstring

  A JSON-based array of structured blocks, presented as a URL-encoded string.

• as_userboolean

  Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.

• channelstringObligatorio

  Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.

• icon_urlstring

  URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• usernamestring

  Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• thread_tsstring

  Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.

• icon_emojistring

  Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

• link_namesboolean

  Find and link channel names and usernames.

• attachmentsstring

  A JSON-based array of structured attachments, presented as a URL-encoded string.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstring

  The ID of the conversation (channel, direct message, or group message) to set the purpose for.

• purposestring

  The new purpose for the conversation. This text will be displayed as the channel description. The maximum length is 250 characters.

Parámetros de salida

• dataobjectObligatorio

  The response data containing the updated conversation information and a success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• num_minutesstringObligatorio

  Number of minutes, from now, to snooze until.

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• imagestringObligatorio

  File contents via a POST var called image.

• crop_winteger

  Width/height of crop box (always square)

• crop_xinteger

  X coordinate of top-left corner of crop box

• crop_yinteger

  Y coordinate of top-left corner of crop box

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsinteger

  The timestamp of the message to mark as the most recently read. This is typically a Unix timestamp with microsecond precision (e.g., '1625800000.000200').

• channelstring

  The ID of the public channel, private channel, or direct message to set the read cursor for.

Parámetros de salida

• dataobjectObligatorio

  Contains a boolean field `ok` which is `true` if the read cursor was successfully set.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• topicstring

  The new topic for the conversation. It must be a string up to 250 characters long. Text formatting and linkification are not supported.

• channelstring

  The ID of the public channel, private channel, direct message, or multi-person direct message conversation for which the topic will be set.

Parámetros de salida

• dataobjectObligatorio

  Contains the status of the operation and details of the conversation with the updated topic.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  Name of a single profile field to set. Use with `value` if `profile` is not provided.

• userstring

  ID of the user whose profile will be updated; defaults to authenticated user. Team admins on paid teams can specify another member's ID.

• valuestring

  Value for the single profile field specified by `name`. Use with `name` if `profile` is not provided.

• profilestring

  URL-encoded JSON string of key-value pairs for profile fields to update (max 50 fields, 255 chars per field name). If provided, `name` and `value` are ignored.

Parámetros de salida

• dataobjectObligatorio

  API call success status and updated user profile data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• imagestringObligatorio

  File contents via a POST var called image.

• crop_winteger

  Width/height of crop box (always square)

• crop_xinteger

  X coordinate of top-left corner of crop box

• crop_yinteger

  Y coordinate of top-left corner of crop box

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• textstring

  Content of the 'me message', displayed as an action performed by the user (e.g., if text is 'is feeling happy', it appears as '*User is feeling happy*').

• channelstring

  Specifies the target channel by its public ID (e.g., 'C1234567890'), private group ID, IM channel ID, or name (e.g., '#general', '@username').

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed response from the Slack API, including the channel ID and timestamp of the posted 'me message'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  The unique ID of the remote file registered with Slack. Either this `file` field or the `external_id` field (or both) is required to identify the file.

• channelsstring

  A comma-separated list of channel IDs where the remote file will be shared. These can include public channel IDs, private channel IDs, or direct message channel IDs.

• external_idstring

  The globally unique identifier (GUID) for the remote file, as provided by the app that registered it with Slack. Either this `external_id` field or the `file` field (or both) is required to identify the file.

Parámetros de salida

• dataobjectObligatorio

  Contains the standard Slack API response, usually an 'ok' field indicating success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestring

  The name or title for the call. This will be displayed in Slack to identify the call.

• usersstring

  A JSON string representing an array of user objects to be registered as participants in the call. Each user object in the array should define a participant using their `slack_id` (Slack User ID) and/or an `external_id` (an identifier from the third-party application, unique to that user within that application). For instance: `'''[{"slack_id": "U012A3BCD4E"}, {"external_id": "user-xyz@example.com", "slack_id": "U012A3BCD4F"}]'''`.

• join_urlstringObligatorio

  The URL required for a client to join the call (e.g., a web join link). This field is mandatory.

• created_bystring

  Slack user ID of the creator; optional (defaults to authenticated user) if using a user token, otherwise required.

• date_startinteger

  The start time of the call, specified as a UTC UNIX timestamp in seconds. For example, `1678886400` corresponds to March 15, 2023, at 12:00 PM UTC.

• external_unique_idstringObligatorio

  A unique identifier for the call, supplied by the third-party call provider. This ID must be unique across all calls from that specific service. This field is required.

• external_display_idstring

  An optional, human-readable identifier for the call, supplied by the third-party call provider. If provided, this ID will be displayed in the Slack call object interface.

• desktop_app_join_urlstring

  An optional URL that, when provided, allows Slack clients to attempt to directly launch the third-party call application. This is typically a deep link URI for the specific application.

Parámetros de salida

• dataobjectObligatorio

  Wrapper for the API response. The `ok` field confirms successful call registration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• presence_subboolean

  Delivers presence events only for explicitly subscribed users if `True`. See Slack's [presence subscriptions](https://slack.dev) documentation.

• batch_presence_awareboolean

  Enables batching of presence status deliveries for subscribed users if `True`, altering `presence_change` event structure. See Slack's [batch presence](https://slack.dev) documentation.

Parámetros de salida

• dataobjectObligatorio

  The core response data containing the WebSocket URL, along with user and team information for the RTM session.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channel_idstringObligatorio

  The unique identifier of the public or private channel to be unarchived.

Parámetros de salida

• dataobjectObligatorio

  The response payload indicating the outcome of the unarchive operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  ID of conversation to unarchive

Parámetros de salida

• dataobjectObligatorio

  Response data

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• channelstringObligatorio

  The ID of the channel where the message is pinned (e.g., a public channel, private channel, or direct message).

• timestampstring

  Timestamp of the message to unpin. This is required to identify the specific message to be removed from the channel's pinned items.

Parámetros de salida

• dataobjectObligatorio

  The response from Slack API, typically indicating if the unpin operation was successful.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  New name for the User Group. Must be unique among User Groups.

• handlestring

  New mention handle. Must be unique among channels, users, and User Groups.

• channelsstring

  Comma-separated encoded channel IDs to set as default channels.

• usergroupstringObligatorio

  Encoded ID of the existing User Group to update.

• descriptionstring

  New short description for the User Group.

• include_countboolean

  If true, include the number of users in the User Group in the response.

Parámetros de salida

• dataobjectObligatorio

  The outcome of the update operation and the updated User Group details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idstringObligatorio

  Unique identifier of the call to update, obtained when a call is created (e.g., via `calls.add` Slack API method).

• titlestring

  New title for the call.

• join_urlstring

  New URL for clients to join the call.

• desktop_app_join_urlstring

  URL to directly launch the third-party call application from Slack clients.

Parámetros de salida

• dataobjectObligatorio

  Contains the response from the Slack API, typically indicating the success status of the update operation (e.g., `{'ok': true}`).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tsstringObligatorio

  Timestamp of the message to update (string, Unix time with microseconds, e.g., `'1234567890.123456'`).

• textstring

  This sends raw text only, use markdown_text field for formatting. New message text (plain or mrkdwn). Not required if `blocks` or `attachments` are provided. See Slack formatting rules.

• parsestring

  Parse mode for `text`: `'full'` (mrkdwn) or `'none'` (literal). If not provided, defaults to `'client'` behavior, overriding original message's `parse` setting.

• blocksstring

  **DEPRECATED**: Use `markdown_text` field instead. URL-encoded JSON array of layout blocks. Replaces existing blocks if field is provided; use `[]` (empty array string) to clear. Omit field to leave blocks untouched. Required if `text` and `attachments` are absent. See Slack API for format.

• as_userstring

  Set to `'true'` to update as the authenticated user (bots are considered such). Defaults to app/bot identity.

• channelstringObligatorio

  The ID of the channel containing the message to be updated.

• link_namesstring

  Set to `'true'` to link channel/user names in `text`. If not provided, Slack's default update behavior may override original message's linking settings.

• attachmentsstring

  URL-encoded JSON array of attachments. Replaces existing attachments if field is provided; use `[]` (empty array string) to clear. Omit field to leave attachments untouched. Required if `text` and `blocks` are absent. See Slack API for format.

• markdown_textstring

  **PREFERRED**: Write your updated message in markdown for nicely formatted display. Supports headers (#), bold (**text**), italic (*text*), strikethrough (~~text~~), code (```), links ([text](url)), quotes (>), and dividers (---). Your message will be posted with beautiful formatting.

Parámetros de salida

• dataobjectObligatorio

  The response data containing details of the updated message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  Slack's unique identifier for the remote file (e.g., `F12345678`). Used to identify the file if `external_id` is not provided. One of `file` or `external_id` is required to specify the file to update.

• titlestring

  New title for the remote file. If omitted, the current title remains unchanged.

• tokenstring

  Authentication token for authorizing the API request to Slack.

• filetypestring

  New filetype for the remote file. This typically describes the kind of file, e.g., `pdf`, `gdoc`, `image`, `text`. See Slack API documentation for specific supported `filetype` values. Providing an inaccurate filetype might affect how the file is handled or displayed.

• external_idstring

  Creator-defined Globally Unique Identifier (GUID) for the remote file. Used to identify the file if `file` ID is not provided. One of `file` or `external_id` is required to specify the file to update.

• external_urlstring

  New publicly accessible URL for the remote file. If provided, this updates the link associated with the file in Slack.

• preview_imagestring

  A string that references the new preview image for the document. The referenced image data will be sent as `multipart/form-data`. This could be a local file path (if supported by the client), a public URL, or base64 encoded image data. Max 1MB. Updates the file's preview in Slack.

• indexable_file_contentsstring

  Plain text content extracted from the remote file, used by Slack to improve searchability. This can be a summary or the full text. Maximum 1MB. If provided, updates the searchable content.

Parámetros de salida

• dataobjectObligatorio

  Standard Slack API response wrapper. The `ok` field within indicates success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usersstringObligatorio

  Comma-separated string of encoded user IDs for the new, complete member list, replacing all existing members. User IDs typically start with 'U' or 'W'.

• usergroupstringObligatorio

  The encoded ID of the User Group whose members are to be updated. This ID typically starts with 'S'.

• include_countboolean

  If true, the response `usergroup` object includes `user_count` and potentially `channel_count` fields, reflecting counts after the update.

Parámetros de salida

• dataobjectObligatorio

  Contains the API response data, primarily the updated `usergroup` object detailing the User Group after the member update.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filestring

  Binary file content as multipart/form-data; use for non-text files. Omit if `content` is used. Provide actual file content, not a path.

• titlestring

  Title of the file, displayed in Slack.

• tokenstring

  Authentication token; requires `files:write` scope.

• contentstring

  Text content of the file; use for text-based files. Omit if `file` is used.

• channelsstring

  Comma-separated channel names or IDs for sharing; if omitted, file is private to the uploader.

• filenamestring

  Filename to be displayed in Slack.

• filetypestring

  Slack file type (e.g., 'text', 'pdf'); Slack auto-detects if omitted. Refer to Slack API for full list.

• thread_tsinteger

  Timestamp of a parent message to upload this file as a reply; use the original message's `ts`.

• initial_commentstring

  Optional message to introduce the file in specified `channels`.

Parámetros de salida

• dataobjectObligatorio

  Contains the details of the uploaded file and the request status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not