Skip to content
Bottle

Put a version of a document in force

PUT
/console/policies/{document}
curl --request PUT \
  --url https://example.com/console/policies/terms \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "version": "2026-09-28", "summary": "example" }'

Sets the version everybody must have accepted, as the date the document took effect. Anybody whose acceptance is older is asked again the next time they use Bottle: their drivers carry on delivering and they can still read and export, while office work waits. Moving the date backwards asks nobody: somebody who accepted a later version has agreed to more, not less.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
document
required
string
Allowed values: terms privacy

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
string
/^\d{4}-\d{2}-\d{2}$/
Example
2026-09-28
summary
string | null
<= 300 characters

Responses

Section titled “Responses”

200

Section titled “200”

In force

Media typeapplication/json
object
document
required
string
Allowed values: terms privacy
version
required
string
/^\d{4}-\d{2}-\d{2}$/
summary
required
string | null
setAt
required
string format: date-time
Example
{
  "document": "terms",
  "version": "2026-09-28"
}

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 Bottle staff, no two-step sign-in, or a console role too low for this

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"
    }
  ]
}