GEgetstream
product:chat

Delete a scheduled message

Changed on

Cancels a scheduled message so it is never sent, or removes a failed one. Returns 409 while the message is being sent

Sends events:

  • scheduled_message.deleted
delete/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

Response

Successful response

durationstring required

Duration of the request in milliseconds

Changes