PlaybookUpdateRequest
Replace a playbook's name, description and positions. A PUT, and it replaces at the MAP level: a clause type absent from `positions` is removed from the playbook. Within a clause type that IS present, the five unpublished authoring fields are preserved (see `playbook_positions.PRESERVED_ON_WRITE`), because the alternative is deleting a lawyer's work with no error and no way to notice. `contractType` is absent on purpose, and so is `isDefault`. Both are explained in the module docstring.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Replacement display name. Required: this is a PUT, not a patch. |
| description | object | Replacement description, or null to clear it. |
| positions | object | The COMPLETE set of positions after the write. Replacement happens at the map level: a clause type you omit is removed from the playbook. Within a clause type you do send, unpublished authoring fields |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/vaquill-ai/json-schema/vaquill-ai-playbook-update-request-schema.json",
"title": "PlaybookUpdateRequest",
"description": "Replace a playbook's name, description and positions.\n\nA PUT, and it replaces at the MAP level: a clause type absent from\n`positions` is removed from the playbook. Within a clause type that IS\npresent, the five unpublished authoring fields are preserved (see\n`playbook_positions.PRESERVED_ON_WRITE`), because the alternative is deleting\na lawyer's work with no error and no way to notice.\n\n`contractType` is absent on purpose, and so is `isDefault`. Both are\nexplained in the module docstring.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/vaquill-ai-playbooks-api-openapi.yml#/components/schemas/PlaybookUpdateRequest",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"title": "Name",
"description": "Replacement display name. Required: this is a PUT, not a patch."
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
],
"title": "Description",
"description": "Replacement description, or null to clear it."
},
"positions": {
"additionalProperties": {
"$ref": "#/$defs/PlaybookPosition"
},
"propertyNames": {
"maxLength": 80,
"minLength": 1
},
"type": "object",
"maxProperties": 200,
"title": "Positions",
"description": "The COMPLETE set of positions after the write. Replacement happens at the map level: a clause type you omit is removed from the playbook. Within a clause type you do send, unpublished authoring fields set in the web app are preserved."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"$defs": {
"EscalationCondition": {
"properties": {
"attribute": {
"type": "string",
"enum": [
"clause_severity",
"counterparty_paper",
"contract_value",
"governing_law"
],
"title": "Attribute",
"description": "What to test. `clause_severity` is the review's own finding and needs no input; the other three come from the review request's `paperSide` and `dealContext`. A rule naming one you did not supply simply does not fire."
},
"operator": {
"type": "string",
"enum": [
"eq",
"neq",
"gt",
"gte",
"lt",
"lte",
"in"
],
"title": "Operator",
"description": "How to compare `attribute` against `value`. Use `in` with a comma-separated `value`.",
"default": "eq"
},
"value": {
"type": "string",
"maxLength": 200,
"title": "Value",
"description": "What to compare against, always a string and parsed per attribute: `red`, `true`, `1000000`, `CA,NY`."
},
"escalateTo": {
"type": "string",
"enum": [
"manager",
"partner",
"gc"
],
"title": "Escalateto",
"description": "The sign-off level this rule raises the clause to when it fires.",
"default": "partner"
},
"note": {
"anyOf": [
{
"type": "string",
"maxLength": 280
},
{
"type": "null"
}
],
"title": "Note",
"description": "Short explanation of why this escalation exists, shown to whoever reviews the finding."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"attribute",
"value"
],
"title": "EscalationCondition",
"description": "A rule that RAISES a clause's required sign-off when it holds.\n\nThis is what lets a playbook say \"partner normally, but GC if the deal is\nover a million, or if it is on their paper\". The value stays a string across\nevery attribute so the stored shape is uniform; it is parsed per attribute\nwhen the rule is evaluated."
},
"PlaybookPosition": {
"properties": {
"standardPosition": {
"type": "string",
"maxLength": 8000,
"title": "Standardposition",
"description": "The position the organization opens with on this clause type. Required: a position with no standard is not a position."
},
"acceptableRange": {
"type": "string",
"maxLength": 4000,
"title": "Acceptablerange",
"description": "Free-text summary of the acceptable zone. Complements `fallbackLadder` rather than duplicating it: this is the summary, the ladder is the ordered retreat."
},
"escalationTriggers": {
"items": {
"type": "string"
},
"type": "array",
"maxItems": 50,
"title": "Escalationtriggers",
"description": "Free-text conditions that should raise a human's attention. Descriptive only; the machine-evaluated rules are `escalationConditions`."
},
"fallbackLadder": {
"items": {
"type": "string"
},
"type": "array",
"maxItems": 10,
"title": "Fallbackladder",
"description": "Ordered concrete retreat positions, BEST acceptable first. The reviewer steps down this ladder when the standard position is rejected."
},
"dealBreaker": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
],
"title": "Dealbreaker",
"description": "The walk-away floor. A term at or below this is forced to red regardless of what the model reads. Absent means there is no hard floor, which is not the same as a floor of nothing."
},
"priority": {
"anyOf": [
{
"type": "string",
"enum": [
"must_have",
"should_have",
"nice_to_have"
]
},
{
"type": "null"
}
],
"title": "Priority",
"description": "How much this clause matters relative to the others in the playbook."
},
"approvalLevel": {
"anyOf": [
{
"type": "string",
"enum": [
"none",
"manager",
"partner",
"gc"
]
},
{
"type": "null"
}
],
"title": "Approvallevel",
"description": "The sign-off a deviation from this position needs. Feeds a review's `approvalGate`, which is REPORTED and never enforced."
},
"escalationConditions": {
"items": {
"$ref": "#/$defs/EscalationCondition"
},
"type": "array",
"maxItems": 20,
"title": "Escalationconditions",
"description": "Machine-evaluated rules that raise the required sign-off when they hold."
},
"rationale": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"title": "Rationale",
"description": "Why the organization takes this position. Carried into review findings so a reviewer can see the reasoning."
},
"riskWeight": {
"anyOf": [
{
"type": "integer",
"maximum": 5.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Riskweight",
"description": "0 to 5, multiplied by severity to weight the compliance score. Absent falls through to the clause-type default rather than to zero."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "False keeps the position on the playbook but excludes it from review and drafting. This is how an alternative is parked without being deleted.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"standardPosition",
"acceptableRange"
],
"title": "PlaybookPosition",
"description": "The organization's negotiating position on one clause type.\n\nBoth a request and a response shape, which is a deliberate exception to the\n\"read models are looser than write models\" rule the resources follow. A\nposition is authored by the customer rather than produced by a model, so\nthere is no dirty-legacy-value problem to be loose about, and one shape means\na caller can read a playbook, edit one field and write it straight back."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/vaquill-ai-playbook-update-request"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.