Skip to main content
GET
Get session retention settings
Needs the session-retention:read scope. Both rules are off until someone turns one on. For what each rule and setting does, and what an erasure removes, see Session retention.

Authorizations

Authorization
string
header
required

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

Response

Default Response

after_closing_enabled
boolean
required

Erase a session once it has stayed closed for after_closing_days days. A reopened session never matches.

after_closing_days
integer
required

Days after a session is closed before it is erased: a whole number from 15 to 120.

Required range: 15 <= x <= 120
after_inactivity_enabled
boolean
required

Erase a session once it has had no activity for after_inactivity_days days. An open session is closed first.

after_inactivity_days
integer
required

Days without activity before a session is erased: a whole number from 15 to 120.

Required range: 15 <= x <= 120
erase_title
boolean
required

Erasure also replaces the session title.

erase_custom_data
boolean
required

Erasure also empties the session custom data.

erase_ai_traces
boolean
required

Erasure also removes the AI traces recorded for the session.

erase_summary
boolean
required

Erasure also clears the session summary.

anonymize_contact
boolean
required

Erasure also removes every link between the session and its contact.