Delete a scheduled message | Sample

1 parameter · 3 body fields

tokenstringrequired

Authentication token with the `chat:write` scope.

The scheduled message identification and deletion-identity options.

as_userbooleanoptional

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

channelstringrequired

The channel the scheduled_message is posting to

scheduled_message_idstringrequired

`scheduled_message_id` returned from call to chat.scheduleMessage

2 status codes

200Returns a success response containing `ok: true`.

okbooleanrequired

Allowed:true

defaultReturns `ok: false` with an error when the scheduled message or channel cannot be found, authentication or permission checks fail, or an argument is invalid.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:invalid_scheduled_message_idchannel_not_foundbad_tokennot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredekm_access_deniedmissing_scopeinvalid_arguments

okbooleanrequired

Allowed:false

Error handling

channel and scheduled_message_id are required. Use the scheduled message identifier returned by chat.scheduleMessage, and provide as_user only when the token has the chat:write:user scope.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.chatDeleteScheduledMessage.create({
  channel: "example",
  scheduledMessageId: "c0a80123-4567-89ab-cdef-0123456789ab",
  asUser: true,
});

{
  "ok": true
}

Request

Response

Errors