Reference / Consent

create or update a legal document. Requires `settings:write`.

PUT /v1/consent-documents
Secret API key operationId: upsert

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Request body · required

  • doc_type string required

    `terms_of_service | privacy_policy | ...`

  • required boolean

    Whether the document gates sign-in (defaults to true).

  • url string
  • version string required

    Opaque version label; bumping it re-gates every user.

Responses

200 Document saved

Request

curl -X PUT "http://localhost:8080/v1/consent-documents" \
  -H "Content-Type: application/json" \
  -d '{
  "doc_type": "string",
  "required": false,
  "url": "string",
  "version": "string"
}'

Try it

live request
PUT http://localhost:8080/v1/consent-documents

Request body

application/json