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

Templates

POST
/api/v1/instance/legal/templates
curl --request POST \
  --url https://example.com/api/v1/instance/legal/templates \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "contact_email": "hello@example.com", "jurisdiction": "example", "operator_name": "example", "postal_address": "" }'

The shipped templates with the operator’s details written in. Saves nothing: Platform puts them in the draft for the operator to edit.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LegalTemplateRequest

The operator’s details, written into the templates once.

object
contact_email
required
Contact Email
string format: email
jurisdiction
required
Jurisdiction
string
>= 1 characters <= 255 characters
operator_name
required
Operator Name
string
>= 1 characters <= 255 characters
postal_address
Postal Address
string
"" <= 500 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
LegalTemplateListResponse
object
items
required
Items
Array<object>
LegalTemplateRead
object
content
required
Content
object
key
additional properties
string
kind
required
LegalDocumentKind

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

string
Allowed values: terms privacy

Example 

{
  "items": [
    {
      "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"
    }
  ]
}