Embedded APIResourcesData retention

Update data retention period

Updates the data retention period for customer workspaces where the Configurable Data Retention capability is enabled.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The external ID must be URL encoded and prefixed with an E (for example, EA2300).

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
data_retention_ttl_hoursintegerOptional
The length of time to retain data for the specified customer workspace, in hours. The minimum data retention period is 1 hour, and the maximum is determined by the Embedded customer's plan.

Response

Success response
statusstring or null
Status of the request.
managed_user_idstring or null
The managed user ID for which the data retention period was updated.
data_retention_ttl_hoursinteger or null
Updated data retention period in hours.

Errors