Chat icon

Chat

Interact with the Chat API

Actions253

Scheduled Message → Update

AI-generated

Summary

Update a scheduled message

Inputs

  • accountId (required) — The account to use for the update operation.
  • scheduledMessageId (required) — The ID of the scheduled message to update.
  • updateFields — Fields to update, including content, scheduled_at, status, template_params, title, recurrence_type, recurrence_interval, recurrence_days, recurrence_end_type, recurrence_end_date, recurrence_max_occurrences.

Output shape

a single updated scheduled message object

Returns the updated scheduled message with the applied changes; fields not provided remain unchanged.

Examples

Example 1: Modify the message text and reschedule it for a later time

Set content to "Hello world", scheduled_at to "2025-01-01T12:00:00Z", keep other fields unchanged.

Example 2: Change status to pending to schedule the message

Set status to "pending" while keeping scheduled_at unchanged.

Example 3: Configure daily recurrence with interval 2

Set recurrence_type to "daily", recurrence_interval to 2, recurrence_end_type to "occurrences", recurrence_max_occurrences to 5.

Links

Discussion