chat.deleteScheduledMessage

Deletes a pending scheduled message from the queue.

Facts

Method access

HTTP
JavaScript
Python
Java
HTTP
POSThttps://slack.com/api/chat.deleteScheduledMessage
Bolt for Java
app.client().chatDeleteScheduledMessage
Powered by Bolt
Bolt for Python
app.client.chat_deleteScheduledMessage
Powered by Bolt
Bolt for JavaScript
app.client.chat.deleteScheduledMessage
Powered by Bolt

Content types

application/x-www-form-urlencodedapplication/json
  • Rate limits

    Tier 3
  • Arguments

    ArgumentTypeDescription
    tokenRequired

    Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

    Examplexxxx-xxxxxxxxx-xxxx
    channelRequired
    string

    The channel the scheduled_message is posting to

    ExampleC123456789
    scheduled_message_idRequired
    string

    scheduled_message_id returned from call to chat.scheduleMessage

    ExampleQ1234ABCD
    as_user
    boolean

    Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

    Exampletrue

    This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

    Example responses

    Common successful response

    Typical success response

    {
        "ok": true
    }
    Common error response

    Typical error response if no message is found

    {
        "ok": false,
        "error": "invalid_scheduled_message_id"
    }

    This method deletes a pending scheduled message before it is sent.

    There are two ways to determine the scheduled_message_id of a message you wish to delete:

    • The response of the chat.scheduleMessage endpoint contains the scheduled_message_id needed to delete that message.
    • You can also retrieve the scheduled_message_ids for all the messages you've scheduled by calling chat.scheduledMessages.list.

    Restrictions

    You cannot delete scheduled messages that have already been posted to Slack or that will be posted to Slack within 60 seconds of the delete request. If attempted, this method will respond with an invalid_scheduled_message_id error.

    Errors

    This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

    ErrorDescription
    invalid_scheduled_message_id

    The scheduled_message_id passed is either an invalid ID, or the scheduled message it's referencing has already been sent or deleted.

    channel_not_found

    The channel passed is either an invalid ID or does not exist.

    bad_token

    The provided token was invalid.

    not_authed

    No authentication token provided.

    invalid_auth

    Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.

    account_inactive

    Authentication token is for a deleted user or workspace when using a bot token.

    token_revoked

    Authentication token is for a deleted user or workspace or the app has been removed when using a user token.

    token_expired

    Authentication token has expired

    no_permission

    The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.

    org_login_required

    The workspace is undergoing an enterprise migration and will not be available until migration is complete.

    ekm_access_denied

    Administrators have suspended the ability to post a message.

    missing_scope

    The token used is not granted the specific scope permissions required to complete this request.

    not_allowed_token_type

    The token type used in this request is not allowed.

    method_deprecated

    The method has been deprecated.

    deprecated_endpoint

    The endpoint has been deprecated.

    two_factor_setup_required

    Two factor setup is required.

    enterprise_is_restricted

    The method cannot be called from an Enterprise.

    team_access_not_granted

    The token used is not granted the specific workspace access required to complete this request.

    invalid_arguments

    The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.

    invalid_arg_name

    The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

    invalid_array_arg

    The method was passed an array as an argument. Please only input valid strings.

    invalid_charset

    The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

    invalid_form_data

    The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

    invalid_post_type

    The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

    missing_post_type

    The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

    team_added_to_org

    The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

    invalid_json [hidden]The method was called via a `POST` request with `Content-Type` `application/json`, but the body was not valid JSON.
    json_not_object [hidden]The method was called via a `POST` request a valid JSON body, but the JSON value was not an object.
    ratelimited

    The request has been ratelimited. Refer to the Retry-After header for when to retry the request.

    accesslimited

    Access to this method is limited on the current network

    request_timeout

    The method was called via a POST request, but the POST data was either missing or truncated.

    upgrade_required [hidden]The calling application needs to be upgraded.
    service_unavailable

    The service is temporarily unavailable

    fatal_error

    The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

    internal_error

    The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

    Warnings

    This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

    WarningDescription
    missing_charset

    The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

    superfluous_charset

    The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

    Arguments

    Need a token? Create and install a Slack app to begin.
    This will make a real API request. Beware of using it with live workspaces.

    API response


    Submit your arguments to see the API response
    Calling chat.deleteScheduledMessage
    Java
    JavaScript
    Python
    HTTP
    Java
    import com.slack.api.Slack;
    import com.slack.api.methods.SlackApiException;
    import org.slf4j.LoggerFactory;
    
    import java.io.IOException;
    
    public class ChatDeleteScheduledMessage {
    
        /**
         * Deletes scheduled message using channel ID and scheduled message ID
         */
        static void deleteScheduledMessage(String channel, String id) {
            // you can get this instance via ctx.client() in a Bolt app
            var client = Slack.getInstance().methods();
            var logger = LoggerFactory.getLogger("my-awesome-slack-app");
            try {
                var result = client.chatDeleteScheduledMessage(r -> r
                    // The token you used to initialize your app
                    .token(System.getenv("SLACK_BOT_TOKEN"))
                    .channel(channel)
                    .scheduledMessageId(id)
                );
                // Print result
                logger.info("result: {}", result);
            } catch (IOException | SlackApiException e) {
                logger.error("error: {}", e.getMessage(), e);
            }
        }
    
        public static void main(String[] args) throws Exception {
            deleteScheduledMessage("C12345", "Q123ABC95");
        }
    
    }
    
    JavaScript
    Code to initialize Bolt app
    // Require the Node Slack SDK package (github.com/slackapi/node-slack-sdk) const { WebClient, LogLevel } = require("@slack/web-api"); // WebClient insantiates a client that can call API methods // When using Bolt, you can use either `app.client` or the `client` passed to listeners. const client = new WebClient("xoxb-your-token", { // LogLevel can be imported and used to make debugging simpler logLevel: LogLevel.DEBUG });
    // The ts of the message you want to delete const messageId = "U12345"; // ID of channel that the scheduled message was sent to const channelId = "C12345"; try { // Call the chat.deleteScheduledMessage method using the WebClient const result = await client.chat.deleteScheduledMessage({ channel: channelId, scheduled_message_id: messageId }); console.log(result); } catch (error) { console.error(error); }
    Python
    Code to initialize Bolt app
    import logging import os # Import WebClient from Python SDK (github.com/slackapi/python-slack-sdk) from slack_sdk import WebClient from slack_sdk.errors import SlackApiError # WebClient insantiates a client that can call API methods # When using Bolt, you can use either `app.client` or the `client` passed to listeners. client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN")) logger = logging.getLogger(__name__)
    # The ts of the message you want to delete message_id = "U12345" # ID of channel that the scheduled message was sent to channel_id = "C12345" try: # Call the chat.deleteScheduledMessage method using the built-in WebClient result = client.chat_deleteScheduledMessage( channel=channel_id, scheduled_message_id=message_id ) # Log the result logger.info(result) except SlackApiError as e: logger.error(f"Error deleting scheduled message: {e}")
    HTTP
    POST https://slack.com/api/chat.deleteScheduledMessage
    Content-type: application/json
    Authorization: Bearer xoxb-your-token
    {
        "channel": "YOUR_CHANNEL_ID",
        "scheduled_message_id": "YOUR_SCHEDULED_MESSAGE_ID"
    }

    Was this page helpful?