GEgetstream
product:chat

Update a scheduled message

Changed on

Replaces the message and/or the send time of a scheduled message. The scheduling checks run again, and the message is then sent, under the caller's auth mode. A request that changes only scheduled_at keeps the auth mode the message was scheduled with. Returns 409 while the message is being sent

Sends events:

  • scheduled_message.updated
patch/scheduled_messages/{id}

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/scheduled_messages/{id}
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Path parameters

idstring required

ID of the scheduled message

Request body

scheduled_atstring date-time

New send time (UTC). Must be in the future and at most the app's maximum lead time from now. Rounded up to the first whole minute that is at least 1 minute from now, never earlier than requested. Resending the stored time leaves it unchanged

Response

Successful response

durationstring required

Duration of the request in milliseconds

Changes