Move a comment pin
move_comment_pin
Moves the pin of a comment to a different spot on the preview.
Scopecomments:writeMakes changes
Use it when a redesign has left a pin sitting over the wrong thing. It moves the pin position and, on a comment that is already tied to an element, its fallback coordinates. The text of the comment is untouched.
It cannot re-tie a comment to a different element, and it cannot give an element anchor to a comment that never had one. See Comments.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
commentId |
string | Yes | The comment id, from list_comments. |
position |
object | No | The new pin position, with X (across the preview, 0 to 1), Y (down the preview, 0 to 1) and Zoom (the preview zoom it was placed at). Leaving Zoom out keeps the current zoom. |
anchorDoc |
object | No | New fallback coordinates on the page, used when the anchored element is gone. It needs both DocX (across the page, 0 to 1) and DocY (down the page, 0 to 1), and is ignored on a comment that is not tied to an element. |