Commands  ›   ›  Edit Text Note

Edit Text Note

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. A valid TextNote element ID must be provided.

After it runs

The specified TextNote is updated with new content, position, and/or type. LastQueryResult contains a JSON summary of the edit.

When to use this

Don't use this when

Creating new text notes (use a create text note command instead). Editing keynotes or tags (different element types). Batch-editing multiple text notes at once.

Inputs

NameKindTypeRequiredDefaultDescription
elementId config int no Text note element id
content config string no Optional new content
x config number no Optional new X coordinate in mm
y config number no Optional new Y coordinate in mm
textType config string no Optional new text type name

Returns

NameTypeDescription
ResultJSONEdit result with id, text, position

What you'll see in the chat

on start
Editing the text note...
Updating your text annotation...
thinking
Locating the text note element...
Applying content and position changes...
Resolving text type...
on success
Text note {elementId} updated successfully.
on failure
Could not edit text note: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/edit_text_note
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

edit text note · update text · move text note · change text type · modify annotation
Patterns: edit * text · update * text note · move * text · change * text type

Related commandsCreateTextNoteCommand
Pillar