A valid request URL is required to generate request examples{
"version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"body_markdown": "<string>",
"summary": "<string>",
"requires_reacceptance": true,
"effective_at": "2023-11-07T05:31:56Z",
"accept_by": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"in_force": true,
"acceptances": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Write the next version
Requires legal:manage. Creates a draft. There is no way to create a published version, which is the point of publishing being its own act: it is the moment words start governing people.
The version number is assigned here — 1, 2, 3 per document — and there is one draft at a time, refused with draft_exists rather than silently producing two. Two people opening the editor at once is the ordinary way a second draft is born, and the next version of one document is one text.
requires_reacceptance defaults to true, and the direction of that default is the decision: a version somebody bothered to write is a change to the agreement until they say otherwise. false is the corrected typo, the fixed link, the reformatted heading — it does not mean “minor”, it means “an acceptance of the previous words is still an acceptance of these”.
A valid request URL is required to generate request examples{
"version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"body_markdown": "<string>",
"summary": "<string>",
"requires_reacceptance": true,
"effective_at": "2023-11-07T05:31:56Z",
"accept_by": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"in_force": true,
"acceptances": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
Corpo
Writing or editing a draft. Publishing is a separate act.
The text. Required on creation, at most 400,000 characters.
What changed. Empty is the ordinary first version — there is nothing to have changed from.
Defaults to true. false is the corrected typo: an acceptance of the previous words is still an acceptance of these.
Resposta
The draft.
One version's words. Frozen the moment it is published: body, summary, effective date and requires_reacceptance all become immutable, because an acceptance names this row.
Show child attributes
Show child attributes