Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Publish

POST
/api/v1/instance/legal/{kind}/publish
curl --request POST \
  --url https://example.com/api/v1/instance/legal/terms/publish \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "requires_acceptance": true }'

Publish a legal document’s draft as a new version.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required
LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string
Allowed values: terms privacy

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LegalPublishRequest
object
requires_acceptance
required
Requires Acceptance
boolean

Example generated

{
  "requires_acceptance": true
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
LegalDocumentAdminRead

Platform’s view of one document: the working draft, whether it differs from what’s published, and every published version.

object
draft
required
LegalDraftRead
object
content
required
Content
object
key
additional properties
string
updated_at
required
Any of:
string format: date-time
has_unpublished_changes
required
Has Unpublished Changes
boolean
kind
required
LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string
Allowed values: terms privacy
versions
required
Versions
Array<object>
LegalVersionSummary
object
languages
required
Languages
Array<string>
published_at
required
Published At
string format: date-time
published_by
required
Any of:
string
requires_acceptance
required
Requires Acceptance
boolean
version
required
Version
integer

Example 

{
  "kind": "terms"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}