API · Create · Documents
Set document clause toggle.
Flip a configurable bylaws (or other template-rendered Document) clause from its default and have the rendered PDF re-emit accordingly. Appends a record to Document.clause_toggle_changes[] (audit trail) and updates the corresponding Document.clause_toggles[] entry.
Re-renders the PDF if the Document is still in execution_status = draft. After execution, calls return 409 document_already_executed — clause changes after execution must go through the bylaws-amendment Resolution path, not this verb.
Cascades. - Updates Document.clause_toggles[].current_value. - Appends to Document.clause_toggle_changes[]. - Re-renders PDF; bumps Document.version. - Re-runs structured_clauses[] extraction.
Returns 202 Accepted. On completion, emits document.clause_toggled. Subscribe via `POST /v1/webhook_endpoints` to consume.
Last updated
Path Parameters
idstringRequiredclause_idstringRequiredStable clause identifier. At launch:
action_by_written_consent_allowed,
supermajority_quorum_basis_points,
dual_class_voting_enabled,
forum_selection_clause_chancery,
advance_notice_bylaw_days. Adding more is enum extension only.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
new_valueanyRequiredNew value, typed per clause (boolean, integer, basis_points).
override_basisstringOptionalOne of
"founder_intent""counsel_advice""board_resolution""prior_practice"notestringOptionalFree-text reason for the change.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/documents/string/clause_toggles/string/set" \ -H "Content-Type: application/json" \ -d '{ "new_value": null }'const body = JSON.stringify({ "new_value": null})fetch("https://api.mattermode.com/v1/documents/string/clause_toggles/string/set", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/documents/string/clause_toggles/string/set" body := strings.NewReader(`{ "new_value": null }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "new_value": {}}resp = requests.post( "https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/clause_toggles/id_placeholder/set", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "new_value": null}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/documents/string/clause_toggles/string/set")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "new_value": null}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/documents/string/clause_toggles/string/set", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/clause_toggles/id_placeholder/set' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "new_value": {}}'const response = await fetch("https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/clause_toggles/id_placeholder/set", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "new_value": {} }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"request_id": "string",
"document": {
"id": "string",
"object": "document",
"entity_id": "string",
"type": "certificate_of_incorporation",
"provenance": "matter_generated",
"status": "draft",
"execution_status": "draft",
"lifecycle_class": "agreement",
"upstream_provenance": null,
"terminated_at": "2019-08-24",
"terminated_reason": null,
"clause_toggles": [
{
"clause_id": "string",
"current_value": null,
"default_value": null,
"override_basis": null,
"set_at": 0,
"set_by_stakeholder_id": "string"
}
],
"clause_toggle_changes": [
{
"clause_id": "string",
"previous_value": null,
"new_value": null,
"override_basis": null,
"changed_at": 0,
"changed_by_stakeholder_id": "string",
"note": "string"
}
],
"internal_notes": "string",
"structured_clauses": [
{
"clause_id": "string",
"value_type": "integer",
"value": null,
"source_section": "string",
"extracted_at": 0
}
],
"efile_metadata": {
"rail": "irs_id_me_portal",
"irs_confirmation_number": "string",
"confirmed_at": "2019-08-24T14:15:22Z",
"form_15620_document_id": "string",
"sub_agent_session_id": "string"
},
"attaches_to": "string",
"attachment_kind": null,
"related_documents": [
{
"document_id": "string",
"relation_kind": "co_executed_with",
"note": "string",
"established_at": "2019-08-24T14:15:22Z"
}
],
"cover_page_fields": {},
"equity_promise": {
"kind": "iso",
"shares_promised": 0,
"strike_price_status": "pending_409a",
"derived_from_valuation_id": "string",
"fixed_strike_price_usd": 0,
"vesting_schedule_promised": {
"total_months": 0,
"cliff_months": 0,
"commencement_anchor": "start_date",
"acceleration": null,
"expected_grant_date": "2019-08-24"
},
"board_approval_status": "pending",
"realized_grant_id": "string"
},
"standard_terms_template_id": "string",
"template_id": "string",
"template_version": "string",
"current_version_id": "string",
"entity_snapshot": {},
"payload": {},
"pdf_url": "http://example.com",
"sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"proof": {
"algorithm": "Ed25519",
"value": "string",
"signing_key_fingerprint": "string"
},
"version": 1,
"parent_document_id": "string",
"signatures": [
{
"stakeholder_id": "string",
"signed_at": 0,
"signature_method": "esign",
"legal_basis": "wet_signature",
"consent_record": {
"consent_id": "string",
"ip": "string",
"user_agent": "string",
"accepted_at": 0,
"esra_disclosure_version": "2026-04-01"
},
"agent_authority": {
"token_id": "string",
"authorization_id": "string",
"principal_human_id": "string",
"agent_id": "string",
"acknowledgements": [
{
"slug": "not_legal_advice",
"version": "2026-04-01",
"accepted_by_stakeholder_id": "string",
"accepted_at": 0,
"ip": "string",
"user_agent": "string"
}
],
"standing_policy_id": "string"
},
"intent_text": "string"
}
],
"envelope_id": "string",
"sensitivity": "standard",
"disclaimer": {
"text": "string",
"version": "2026-04-01",
"source": "ueta_matter_v1",
"marketing_disclosure_url": "http://example.com"
},
"metadata": {
"customer_id": "cus_7Hpx9WxY",
"portfolio_tag": "y-combinator-w26"
},
"created": 0,
"updated": 0,
"livemode": true
}
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/invalid_state_transition",
"title": "Invalid state transition",
"status": 409,
"code": "invalid_state_transition",
"detail": "Entity ent_Nq3KcAbc is in state `dissolved`; `dissolve` is not a valid transition.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_state_transition",
"request_id": "req_Qw9xYz8A",
"current_state": "dissolved",
"attempted_transition": "dissolve",
"allowed_transitions": []
}{
"type": "https://mattermode.com/docs/errors/dissolution_prerequisites_missing",
"title": "Dissolution prerequisites missing",
"status": 409,
"code": "dissolution_prerequisites_missing",
"detail": "Voluntary dissolution requires `board_resolution_id` and `stockholder_consent_id`, or `auto_generate_resolutions: true`.",
"doc_url": "https://mattermode.com/docs/guides/errors#dissolution_prerequisites_missing",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/valuation_stale",
"title": "409A valuation stale",
"status": 409,
"code": "valuation_stale",
"detail": "Active 409A val_AbCd1234 is older than 12 months or superseded by a material event. Issuing ISOs at the prior strike risks IRC §409A violation. Refresh via POST /entities/{id}/valuations/{id}/refresh_request.",
"doc_url": "https://mattermode.com/docs/guides/errors#valuation_stale",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "One or more fields failed validation. See `errors[]`.",
"doc_url": "https://mattermode.com/docs/guides/errors#validation_failed",
"request_id": "req_Qw9xYz8A",
"errors": [
{
"field": "founders[0].equity",
"code": "out_of_range",
"message": "Equity must sum to 100% across all founders."
}
]
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}