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"
}
}Edit the draft
Requires legal:manage. Partial, and it works on an unpublished version only.
A published version answers 404 here rather than 403, and the distinction is not cosmetic: there is no such thing as an editable published version to be forbidden from touching. The database refuses it too — a trigger, not a convention — because an acceptance names these words, and words that could be edited afterwards would prove that somebody agreed to whatever the text says today.
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"
}
}Authorizations
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.
Headers
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.
Body
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.
Response
The draft as it now stands.
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