Summary
Patch metadata properties on a content control (tag, alias, appearance, color, etc.).- Operation ID:
contentControls.patch - API member path:
editor.doc.contentControls.patch(...) - Mutates document:
yes - Idempotency:
conditional - Supports tracked mode:
no - Supports dry run:
yes - Deterministic target resolution:
yes
Expected result
Returns a ContentControlMutationResult; reports NO_OP if no fields changed.Input fields
| Field | Type | Required | Description |
|---|---|---|---|
alias | any | no | |
appearance | enum | no | "boundingBox", "tags", "hidden" |
color | string | no | |
placeholder | string | no | |
showingPlaceholder | boolean | no | |
tabIndex | integer | no | |
tag | any | no | |
target | object(nodeType=“sdt”) | yes | |
target.kind | enum | yes | "block", "inline" |
target.nodeId | string | yes | |
target.nodeType | "sdt" | yes | Constant: "sdt" |
temporary | boolean | no |
Example request
{
"alias": {},
"tag": {},
"target": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "sdt"
}
}
Output fields
Variant 1 (success=true)
| Field | Type | Required | Description |
|---|---|---|---|
contentControl | object(nodeType=“sdt”) | yes | |
contentControl.kind | enum | yes | "block", "inline" |
contentControl.nodeId | string | yes | |
contentControl.nodeType | "sdt" | yes | Constant: "sdt" |
success | true | yes | Constant: true |
updatedRef | object(nodeType=“sdt”) | no | |
updatedRef.kind | enum | no | "block", "inline" |
updatedRef.nodeId | string | no | |
updatedRef.nodeType | "sdt" | no | Constant: "sdt" |
Variant 2 (success=false)
| Field | Type | Required | Description |
|---|---|---|---|
failure | ReceiptFailure | yes | ReceiptFailure |
failure.code | string | yes | |
failure.details | any | no | |
failure.message | string | yes | |
success | false | yes | Constant: false |
Example response
{
"contentControl": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "sdt"
},
"success": true,
"updatedRef": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "sdt"
}
}
Pre-apply throws
TARGET_NOT_FOUNDINVALID_TARGETAMBIGUOUS_TARGETINVALID_INPUTLOCK_VIOLATIONREVISION_MISMATCHCAPABILITY_UNAVAILABLE
Non-applied failure codes
NO_OP
Raw schemas
Raw input schema
Raw input schema
{
"additionalProperties": false,
"properties": {
"alias": {},
"appearance": {
"enum": [
"boundingBox",
"tags",
"hidden"
]
},
"color": {
"type": "string"
},
"placeholder": {
"type": "string"
},
"showingPlaceholder": {
"type": "boolean"
},
"tabIndex": {
"type": "integer"
},
"tag": {},
"target": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"block",
"inline"
]
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "sdt"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
},
"temporary": {
"type": "boolean"
}
},
"required": [
"target"
],
"type": "object"
}
Raw output schema
Raw output schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"contentControl": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"block",
"inline"
]
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "sdt"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
},
"success": {
"const": true
},
"updatedRef": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"block",
"inline"
]
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "sdt"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
}
},
"required": [
"success",
"contentControl"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"failure": {
"$ref": "#/$defs/ReceiptFailure"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure"
],
"type": "object"
}
]
}
Raw success schema
Raw success schema
{
"additionalProperties": false,
"properties": {
"contentControl": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"block",
"inline"
]
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "sdt"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
},
"success": {
"const": true
},
"updatedRef": {
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"block",
"inline"
]
},
"nodeId": {
"type": "string"
},
"nodeType": {
"const": "sdt"
}
},
"required": [
"kind",
"nodeType",
"nodeId"
],
"type": "object"
}
},
"required": [
"success",
"contentControl"
],
"type": "object"
}
Raw failure schema
Raw failure schema
{
"additionalProperties": false,
"properties": {
"failure": {
"$ref": "#/$defs/ReceiptFailure"
},
"success": {
"const": false
}
},
"required": [
"success",
"failure"
],
"type": "object"
}