Skip to content
Bottle

Update retention settings

PUT
/retention
curl --request PUT \
  --url https://example.com/retention \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "enabled": true, "years": 1, "warnDays": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
boolean
years
integer
>= 1 <= 7
warnDays
integer
<= 180
Examplegenerated
{
  "enabled": true,
  "years": 1,
  "warnDays": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Saved

Media typeapplication/json
object
enabled
required
boolean
years
required
integer
>= 1 <= 7
warnDays
required
integer
<= 180
updatedAt
required
string format: date-time
Examplegenerated
{
  "enabled": true,
  "years": 1,
  "warnDays": 1,
  "updatedAt": "2026-04-15T12:00:00Z"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}