product:chat

Set retention policy

Changed on

Creates or updates a retention policy for the app. Server-side only.

post/retention_policy

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/retention_policy
  • 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

Request body

max_age_hoursinteger required
policy'old-messages' | 'inactive-channels' required

Response

Response

durationstring required

Duration of the request in milliseconds

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property became required

    • breaking

      the request property became required

    • warning

      the request property's max was set to 43800.00

    • warning

      the request property's min was set to 24.00

    • info

      added the new inactive-channels enum value to the request property

    • info

      added the new old-messages enum value to the request property