auto_write

Links a text layer of a design to a field of one of the store's own records, so the words on the design come from the bu

Links a text layer of a design to a field of one of the store's own records, so the words on the design come from the business and stay checked against it: a product's title, price or earlier price, a promotion's name, discount or last day, or a customer review's words, reviewer or rating. The layer's words are replaced where they already show such a value, written the way the layer already wrote it; otherwise the layer shows the value alone. Every later export and post reads the record again and stops when the design no longer matches it. Saved as a new version of the same design; locked layers are left alone. Costs no credits.

post/api/v1/tools/bind_design_data

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/bind_design_data
  • 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 id.

layer_idstring required

The text layer to link, by its id in the design.

source'product' | 'promotion' | 'review' | 'moment' required

What kind of record the words come from.

record_idstring required

The product, promotion or review id.

field'title' | 'price' | 'compare_at' | 'name' | 'discount' | 'ends' | 'quote' | 'author' | 'rating' | 'date' required

For a product: title, price or compare_at (its earlier price). For a promotion: name, discount or ends. For a review: quote (its words, inside the layer's quotation marks), author or rating.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.