Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

Create a new content control (SDT) in the document.
  • Operation ID: create.contentControl
  • API member path: editor.doc.create.contentControl(...)
  • Mutates document: yes
  • Idempotency: non-idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a ContentControlMutationResult with the created content control target.

​
Input fields

FieldTypeRequiredDescription
aliasstringno
contentstringno
controlTypestringno
kindenumyes"block", "inline"
lockModeenumno"unlocked", "sdtLocked", "contentLocked", "sdtContentLocked"
tagstringno
targetobject(nodeType=“sdt”)no
target.kindenumno"block", "inline"
target.nodeIdstringno
target.nodeType"sdt"noConstant: "sdt"

​
Example request

{
  "controlType": "example",
  "kind": "block",
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "sdt"
  }
}

​
Output fields

​
Variant 1 (success=true)

FieldTypeRequiredDescription
contentControlobject(nodeType=“sdt”)yes
contentControl.kindenumyes"block", "inline"
contentControl.nodeIdstringyes
contentControl.nodeType"sdt"yesConstant: "sdt"
successtrueyesConstant: true
updatedRefobject(nodeType=“sdt”)no
updatedRef.kindenumno"block", "inline"
updatedRef.nodeIdstringno
updatedRef.nodeType"sdt"noConstant: "sdt"

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureReceiptFailureyesReceiptFailure
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: 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_FOUND
  • INVALID_TARGET
  • AMBIGUOUS_TARGET
  • INVALID_INPUT
  • LOCK_VIOLATION
  • REVISION_MISMATCH
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • INVALID_TARGET
  • NO_OP

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "alias": {
      "type": "string"
    },
    "content": {
      "type": "string"
    },
    "controlType": {
      "type": "string"
    },
    "kind": {
      "enum": [
        "block",
        "inline"
      ]
    },
    "lockMode": {
      "enum": [
        "unlocked",
        "sdtLocked",
        "contentLocked",
        "sdtContentLocked"
      ]
    },
    "tag": {
      "type": "string"
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "kind": {
          "enum": [
            "block",
            "inline"
          ]
        },
        "nodeId": {
          "type": "string"
        },
        "nodeType": {
          "const": "sdt"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "nodeId"
      ],
      "type": "object"
    }
  },
  "required": [
    "kind"
  ],
  "type": "object"
}

{
  "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"
    }
  ]
}

{
  "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"
}