/v1/autofills

POST {{baseUrl}}/v1/autofills

This API is currently provided as a preview. Be aware of the following:

  • There might be unannounced breaking changes.
  • Any breaking changes to preview APIs won't produce a new API version.
  • Public integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.

To use this API, your integration must act on behalf of a user that's a member of a Canva Enterprise organization.

Starts a new job to autofill a Canva design using a brand template and input data.

To get a list of input data fields, use the Get brand template dataset API.

Brand templates contain references to image media. You can reference image media by providing the value of type with image within the data object. The number of references to image media within a brand template cannot currently exceed 300 references.

Request Body

{"brand_template_id"=>"<string>", "data"=>{"ipsum_a5"=>{"asset_id"=>"<string>", "type"=>"image"}, "laboris3"=>{"asset_id"=>"<string>", "type"=>"image"}}, "title"=>"<string>", "preview"=>"<boolean>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;job&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;in_progress&quot;,&quot;result&quot;:{&quot;design&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;title&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;thumbnail&quot;:{&quot;height&quot;:&quot;\u003cinteger\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;width&quot;:&quot;\u003cinteger\u003e&quot;}},&quot;type&quot;:&quot;create_design&quot;},&quot;error&quot;:{&quot;code&quot;:&quot;thumbnail_generation_error&quot;,&quot;message&quot;:&quot;\u003cstring\u003e&quot;}}}