auto_write

Leaves a review comment on a design, or a reply in an existing thread. A comment can be pinned to a layer, to a point on

Leaves a review comment on a design, or a reply in an existing thread. A comment can be pinned to a layer, to a point on one layout (x and y as fractions of its width and height, with the layout named), to a moment of a video, or to several of those; a reply carries no pin of its own. Made on the newest version unless a version is given. Changes nothing on the design. Costs no credits.

post/api/v1/tools/comment_on_design

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/comment_on_design
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: creative:write)

Request body

design_idstring required

The design to comment on.

bodystring required

The comment.

versioninteger

The saved version it is about; the newest when left out.

reply_tostring

A comment in the thread to answer; the reply joins that thread.

layer_idstring

The layer the comment is about, as the design's layers list it.

placement'square' | 'portrait' | 'story' | 'landscape' | 'wide'

The layout the point is on; needed with x and y.

xnumber

How far across the layout, 0 at the left edge.

ynumber

How far down the layout, 0 at the top.

at_secondsnumber

The moment of a motion design it is about.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.