images.updateCaption

Summary

Update the text of an existing caption paragraph.

Operation ID: images.updateCaption
API member path: editor.doc.images.updateCaption(...)
Mutates document: yes
Idempotency: conditional
Supports tracked mode: yes
Supports dry run: yes
Deterministic target resolution: yes

Expected result

Returns an ImagesMutationResult; reports NO_OP if text unchanged.

Input fields

Field	Type	Required	Description
`imageId`	string	yes
`text`	string	yes

Example request

{
  "imageId": "example",
  "text": "Hello, world."
}

Output fields

Field	Type	Required
`failure`	object	no
`image`	object	no
`success`	boolean	no

Example response

{
  "image": {},
  "success": true
}

Pre-apply throws

TARGET_NOT_FOUND
AMBIGUOUS_TARGET
INVALID_TARGET
CAPABILITY_UNAVAILABLE
INVALID_INPUT

Non-applied failure codes

NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "imageId": {
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "imageId",
    "text"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "type": "object"
    },
    "image": {
      "type": "object"
    },
    "success": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "image": {
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "image"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

images.updateCaption

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas