Skip to main content
PUT
/
v1
/
retention-policies
/
{policy_id}
Update a retention policy
curl --request PUT \
  --url https://api-sandbox.featherhq.com/v1/retention-policies/{policy_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "turn_retention_days": 123,
  "session_retention_days": 123,
  "is_default": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_default": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "turn_retention_days": 123,
  "session_retention_days": 123
}

Authorizations

x-api-key
string
header
required

Path Parameters

policy_id
string<uuid>
required

Body

application/json
name
string | null
turn_retention_days
integer | null
session_retention_days
integer | null
archive_strategy
enum<string> | null
Available options:
soft_delete,
hard_delete
is_default
boolean | null

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
archive_strategy
enum<string>
required
Available options:
soft_delete,
hard_delete
is_default
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
turn_retention_days
integer | null
session_retention_days
integer | null