Hello everyone!
For those who’d like to autofill with tabular data, the Create design autofill job API now accepts sheet data fields, available in preview.
What’s new
We have added sheet elements to the types that the Autofill API can work with, alongside image, text, and charts. Sheet data fields let you fill those sheet elements with your own tabular data using the same Data Table format as charts. Existing autofill integrations experience no behavioural changes.
Key features
This allows you to:
- Autofill sheet elements in brand templates with your own tabular data.
- The existing formatting of the sheet element you’re autofilling will be used with the new sheet data.
- Sheet elements will add columns and rows if your data is larger than the element that is being filled. Formatting of the bottom row and rightmost column will be used for newly added rows and columns.
How to use it
Add a sheet element to a brand template and tag it as a Data Field using the Data autofill app.
In your Create design autofill job API call: pass a data value with "type": "sheet" and a Data Table with the sheet contents:
{
"brand_template_id": "YOUR_BRAND_TEMPLATE_ID",
"data": {
"pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{ "name": "Geographic Region", "type": "string" },
{ "name": "Sales (millions AUD)", "type": "number" },
{ "name": "Target met?", "type": "boolean" },
{ "name": "Date met", "type": "date" }
],
"rows": [
{
"cells": [
{ "type": "string", "value": "Asia Pacific" },
{ "type": "number", "value": 10.2 },
{ "type": "boolean", "value": true },
{ "type": "date", "value": 1721944387 }
]
},
{
"cells": [
{ "type": "string", "value": "EMEA" },
{ "type": "number", "value": 13.8 },
{ "type": "boolean", "value": false },
{ "type": "date" }
]
}
]
}
}
}
}
Usage notes
- The Autofill API is available to members of a Canva Enterprise organization, with a limited trial for integrations under development.
- Autofill jobs are asynchronous: create the job, then poll Get design autofill job for the result, including a link to the newly created design.
Docs & details
Full details, including the complete request schema, are in the Create design autofill job API reference.
Reminder
As this is a preview API, breaking changes may occur. Be sure to monitor our Changelog for updates.
Feedback & questions
If you have any feedback or questions about sheet data fields, please let us know here on this thread.