Slack: Schedules a message to be sent to a channel

← Chat operations · Get started

Operation slack.chat_schedulemessage

Provider route: POST /chat.scheduleMessage. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/slack with npm, or alter-sdk-slack with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SlackIntegration } from "@alter-ai/slack";

async function execute(input: Parameters<SlackIntegration["chat"]["scheduleMessage"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SlackIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.chat.scheduleMessage(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_slack import SlackIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SlackIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.chat.schedule_message(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent
body.as_user	boolean	Optional	Set to `true` to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.
body.attachments	string	Optional	A JSON-based array of structured attachments, presented as a URL-encoded string.
body.blocks	string	Optional	A JSON-based array of structured blocks, presented as a URL-encoded string.
body.channel	string	Required within parent	Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name.
body.link_names	boolean	Optional	Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.
body.markdown_text	string	Optional	Accepts message text formatted in markdown. This argument should not be used in conjunction with `blocks` or `text`. Limit this field to 12,000 characters.
body.metadata	string	Optional	JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.
body.parse	string	Optional	Change how messages are treated. See chat.postMessage.
body.post_at	integer	Required within parent	Unix timestamp representing the future time the message should post to Slack.
body.reply_broadcast	boolean	Optional	Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.
body.text	string	Optional	How this field works and whether it is required depends on other fields you use in your API call.
body.thread_ts	string	Optional	Provide another message’s `ts` value to make this message a reply. Avoid using a reply’s `ts` value; use its parent instead.
body.unfurl_links	boolean	Optional	Pass true to enable unfurling of primarily text-based content.
body.unfurl_media	boolean	Optional	Pass false to disable unfurling of media content.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Schema for successful response of chat.scheduleMessage method
channel	string	Optional
message	object	Optional
message.bot_id	string	Optional
message.bot_profile	Model	Optional	Expand Sends a message to a channel — response body — message bot profile
message.team	string	Optional
message.text	string	Optional
message.type	string	Optional
message.user	string	Optional
message.username	string	Optional
ok	boolean	Required within parent	Must equal: true
post_at	JSON	Optional
post_at (anyOf 1)	integer	Alternative
post_at (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scheduled_message_id	string	Optional

Referenced models: Sends a message to a channel — response body — message bot profile

Schemas

Sends a message to a channel — response body — message bot profile

Field	Type	Presence	Description and constraints
$	object	Root
app_id	string	Optional
deleted	boolean	Optional
icons	object	Optional
icons.image_36	string	Optional	Format: uri
icons.image_48	string	Optional	Format: uri
icons.image_72	string	Optional	Format: uri
id	string	Optional
name	string	Optional
team_id	string	Optional
updated	JSON	Optional
updated (anyOf 1)	integer	Alternative
updated (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: slack.chat_schedulemessage. Catalog operation: chat_scheduleMessage. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["chat:write"]

Official provider source