GEgetstream
product:chat

Create reminder

Changed on

Creates a new reminder. An optional expires_at hides the reminder from every read once it passes and stops it counting against the per-user reminder cap

Sends events:

  • reminder.created
post/messages/{message_id}/reminders

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/messages/{message_id}/reminders
  • 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

message_idstring required

Request body

expires_atstring date-time
remind_atstring date-time
user_idstring

Response

Response

durationstring required

Duration of the request in milliseconds

Changes

  • 00df5052235bRevision changes
    • info

      added the optional property /// to the response with the status

  • 8acf79c23a74Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status