> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.
# Create design autofill job
Create an asynchronous job to autofill a design from a brand template with your input information.
Autofill for designs and brand templates is available when your app acts on behalf of a user on Canva Pro (including Canva Education and Canva for Nonprofits), Canva Teams, or Canva Enterprise. Usage limits will be introduced in the future.
Starts a new [asynchronous job](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints) to autofill a Canva design using input data. Use the `type` field to choose the source of the design:
* `create_from_brand_template`: autofill a new design from a brand template. If `type` isn't specified in the request, the request type is assumed to be `create_from_brand_template`. To get a list of input data fields for a brand template, use the [Get brand template dataset API](https://www.canva.dev/docs/apps/rest-apis/reference/brand-templates/get-brand-template-dataset/).
* `create_from_design`: autofill a new design from an existing design that contains autofill data fields. To get the input data fields for an existing design, use the [Get design dataset
API](https://www.canva.dev/docs/apps/rest-apis/reference/designs/get-design-dataset/).
* `update_design`: autofill an existing design in place, rather than creating a new design. To get the input data fields for the design, use the [Get design dataset API](https://www.canva.dev/docs/apps/rest-apis/reference/designs/get-design-dataset/).
Data fields in brand templates or designs might change (for example, they might be renamed or removed). If you provide data for a field name that doesn't exist, it's silently skipped. Use the Get dataset APIs to confirm the current fields before creating an autofill job.
Available data field types to autofill include:
* Images (which you can autofill with an image or a video asset)
* Text
* Charts
* Sheets
NOTE: For more information on the workflow for using asynchronous jobs, see [API requests and responses](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints). You can check the status and get the results of autofill jobs created with this API using the [Get design autofill job API](https://www.canva.dev/docs/apps/rest-apis/reference/autofills/get-design-autofill-job/).
## HTTP method and URL path
POST https\://api.canva.com/rest/v1/autofills
This operation is rate limited to 60 requests per minute for each user of your app.
## Authentication and authorization
This endpoint requires a valid access token that acts on behalf of a user. For more information, see [Generate an access token](/docs/apps/rest-apis/reference/authentication/generate-access-token).
### Scopes
The access token must have all the following [scopes](/docs/apps/rest-apis/scopes) (permissions):
* `design:content:write`
## Header parameters
Provides credentials to authenticate the request, in the form of a `Bearer` token.
For example: `Authorization: Bearer {token}`
Indicates the media type of the information sent in the request. This must be set to `application/json`.
For example: `Content-Type: application/json`
## Body parameters
Create a new autofilled design from a brand template.
For backward compatibility, if `type` isn't specified in the request, the request type is assumed to be `create_from_brand_template`.
**Available values:** The only valid value is `create_from_brand_template`.
ID of the input brand template.
Data object containing the data fields and values to autofill.
Properties of data} defaultExpanded={true}>
The data field to autofill.
```json
{
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
```
If the data field is an image field.
**Available values:** The only valid value is `image`.
`asset_id` of the image to insert into the template element.
If autofilling a video into an image data field.
**Available values:** The only valid value is `video`.
`asset_id` of the video to insert into the template element.
If the data field is a text field.
**Available values:** The only valid value is `text`.
Text to insert into the template element.
If the data field is a chart.
Note the following behavior:
* If `column_configs` is not provided, the first row is assumed to contain column headers where applicable.
* Chart autofill supports a maximum of 100 rows and 20 columns.
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for chart autofill and will result in an error response.
**Available values:** The only valid value is `chart`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of chart_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
If the data field is a sheet element.
Note the following behavior:
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for sheet autofill and will result in an error response.
**Available values:** The only valid value is `sheet`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of sheet_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
Title to use for the autofilled design.
If no design title is provided, the autofilled design will have the same title as the brand template.
**Minimum length:** `1`
**Maximum length:** `255`
Create a new autofilled design from an existing design that contains autofill data fields.
**Available values:** The only valid value is `create_from_design`.
ID of the design to use as the autofill source.
Data object containing the data fields and values to autofill.
Properties of data} defaultExpanded={true}>
The data field to autofill.
```json
{
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
```
If the data field is an image field.
**Available values:** The only valid value is `image`.
`asset_id` of the image to insert into the template element.
If autofilling a video into an image data field.
**Available values:** The only valid value is `video`.
`asset_id` of the video to insert into the template element.
If the data field is a text field.
**Available values:** The only valid value is `text`.
Text to insert into the template element.
If the data field is a chart.
Note the following behavior:
* If `column_configs` is not provided, the first row is assumed to contain column headers where applicable.
* Chart autofill supports a maximum of 100 rows and 20 columns.
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for chart autofill and will result in an error response.
**Available values:** The only valid value is `chart`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of chart_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
If the data field is a sheet element.
Note the following behavior:
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for sheet autofill and will result in an error response.
**Available values:** The only valid value is `sheet`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of sheet_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
Title to use for the autofilled design.
If no design title is provided, the autofilled design will have the same title as the source design.
**Minimum length:** `1`
**Maximum length:** `255`
Autofill an existing design in place with the provided data.
**Available values:** The only valid value is `update_design`.
ID of the design to autofill in place.
Data object containing the data fields and values to autofill.
Properties of data} defaultExpanded={true}>
The data field to autofill.
```json
{
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
```
If the data field is an image field.
**Available values:** The only valid value is `image`.
`asset_id` of the image to insert into the template element.
If autofilling a video into an image data field.
**Available values:** The only valid value is `video`.
`asset_id` of the video to insert into the template element.
If the data field is a text field.
**Available values:** The only valid value is `text`.
Text to insert into the template element.
If the data field is a chart.
Note the following behavior:
* If `column_configs` is not provided, the first row is assumed to contain column headers where applicable.
* Chart autofill supports a maximum of 100 rows and 20 columns.
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for chart autofill and will result in an error response.
**Available values:** The only valid value is `chart`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of chart_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
If the data field is a sheet element.
Note the following behavior:
* `number` cells with formatting metadata are not currently supported for autofill and will result in an error response.
* `media` cells are not supported for sheet autofill and will result in an error response.
**Available values:** The only valid value is `sheet`.
Tabular data, structured in rows of cells.
* Each cell must have a data type configured.
* All rows must have the same number of cells.
* The number of entries in `column_configs` must match the number of columns in the data.
Properties of sheet_data}>
Rows of data.
Properties of rows}>
Cells of data in row.
All rows must have the same number of cells.
A string tabular data cell.
**Available values:** The only valid value is `string`.
**Maximum length:** `10000`
A number tabular data cell.
**Available values:** The only valid value is `number`.
Formatting metadata for number cells.
Properties of metadata}>
Formatting pattern using Office Open XML Format.
These patterns control how numbers are displayed to users, including currency symbols,
decimal places, and separators.
A boolean tabular data cell.
**Available values:** The only valid value is `boolean`.
A date tabular data cell.
Specified as a Unix timestamp (in seconds since the Unix Epoch).
**Available values:** The only valid value is `date`.
Cell containing a media collection.
**Available values:** The only valid value is `media`.
Media collection values.
Provide an empty array for an empty cell.
**Maximum items:** `20`
Options for uploading an image asset.
**Available values:** The only valid value is `image_upload`.
The URL of the image file to upload.
This can be an external URL or a data URL.
The URL of a thumbnail image to display while the image is queued for upload.
This can be an external URL or a data URL.
The MIME type of an image file that's supported by Canva's backend.
**Available values:**
* `image/jpeg`
* `image/heic`
* `image/png`
* `image/svg+xml`
* `image/webp`
* `image/tiff`
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The width of the image in pixels.
The height of the image in pixels.
Options for uploading a video asset.
**Available values:** The only valid value is `video_upload`.
The URL of the video file to upload.
The URL of a thumbnail image to use as a fallback if thumbnailVideoUrl isn't provided.
This can be an external URL or a data URL.
The MIME type of a video file that's supported by Canva's backend.
**Available values:**
* `video/avi`
* `video/x-msvideo`
* `image/gif`: GIFs are treated as videos, not images.
* `video/x-m4v`
* `video/x-matroska`
* `video/quicktime`
* `video/mp4`
* `video/mpeg`
* `video/webm`
* `application/json`: Used for Lottie files.
A disclosure identifying if the app generated this media asset using AI.
**Available values:**
* `app_generated`: App creates or significantly alters content using AI
* `none`: No AI involvement in creation or alteration
The URL of a thumbnail video to display while the video is queued for upload.
The width of the video in pixels.
The height of the video in pixels.
Column definitions with names and data types.
Properties of column_configs}>
Expected data type for cells in this column.
**Available values:**
* `string`: String data
* `number`: Numeric data
* `date`: Date data
* `boolean`: Boolean data
* `media`: Media data (such as images, videos, or combinations of both)
* `variant`: Mixed data types (use where the column contains cells of a combination of data types)
Name for the column, displayed as header text.
## Example request
Examples for using the `/v1/autofills` endpoint:
```sh
curl --request POST 'https://api.canva.com/rest/v1/autofills' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"type": "create_from_brand_template",
"brand_template_id": "DAFVztcvd9z",
"title": "My autofilled design",
"data": {
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
}'
```
```js
const fetch = require("node-fetch");
fetch("https://api.canva.com/rest/v1/autofills", {
method: "POST",
headers: {
"Authorization": "Bearer {token}",
"Content-Type": "application/json",
},
body: JSON.stringify({
"type": "create_from_brand_template",
"brand_template_id": "DAFVztcvd9z",
"title": "My autofilled design",
"data": {
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
}),
})
.then(async (response) => {
const data = await response.json();
console.log(data);
})
.catch(err => console.error(err));
```
```java
import java.io.IOException;
import java.net.URI;
import java.net.http.*;
public class ApiExample {
public static void main(String[] args) throws IOException, InterruptedException {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.canva.com/rest/v1/autofills"))
.header("Authorization", "Bearer {token}")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"type\": \"create_from_brand_template\", \"brand_template_id\": \"DAFVztcvd9z\", \"title\": \"My autofilled design\", \"data\": {\"cute_pet_image_of_the_day\": {\"type\": \"image\", \"asset_id\": \"Msd59349ff\"}, \"cute_pet_video_of_the_day\": {\"type\": \"video\", \"asset_id\": \"VAHCkrNUANI\"}, \"cute_pet_witty_pet_says\": {\"type\": \"text\", \"text\": \"It was like this when I got here!\"}, \"cute_pet_sales_chart\": {\"type\": \"chart\", \"chart_data\": {\"column_configs\": [{\"name\": \"Geographic Region\", \"type\": \"string\"}, {\"name\": \"Sales (millions AUD)\", \"type\": \"number\"}, {\"name\": \"Target (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\": \"number\", \"value\": 10}, {\"type\": \"boolean\", \"value\": true}, {\"type\": \"date\", \"value\": 1721944387}]}, {\"cells\": [{\"type\": \"string\", \"value\": \"EMEA\"}, {\"type\": \"number\", \"value\": 13.8}, {\"type\": \"number\", \"value\": 14}, {\"type\": \"boolean\", \"value\": false}, {\"type\": \"date\"}]}]}}, \"cute_pet_sales_sheet\": {\"type\": \"sheet\", \"sheet_data\": {\"column_configs\": [{\"name\": \"Geographic Region\", \"type\": \"string\"}, {\"name\": \"Sales (millions AUD)\", \"type\": \"number\"}, {\"name\": \"Target (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\": \"number\", \"value\": 10}, {\"type\": \"boolean\", \"value\": true}, {\"type\": \"date\", \"value\": 1721944387}]}, {\"cells\": [{\"type\": \"string\", \"value\": \"EMEA\"}, {\"type\": \"number\", \"value\": 13.8}, {\"type\": \"number\", \"value\": 14}, {\"type\": \"boolean\", \"value\": false}, {\"type\": \"date\"}]}]}}}}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}
```
```py
import requests
headers = {
"Authorization": "Bearer {token}",
"Content-Type": "application/json"
}
data = {
"type": "create_from_brand_template",
"brand_template_id": "DAFVztcvd9z",
"title": "My autofilled design",
"data": {
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": True
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": False
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": True
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": False
},
{
"type": "date"
}
]
}
]
}
}
}
}
response = requests.post("https://api.canva.com/rest/v1/autofills",
headers=headers,
json=data
)
print(response.json())
```
```csharp
using System.Net.Http;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("https://api.canva.com/rest/v1/autofills"),
Headers =
{
{ "Authorization", "Bearer {token}" },
},
Content = new StringContent(
"{\"type\": \"create_from_brand_template\", \"brand_template_id\": \"DAFVztcvd9z\", \"title\": \"My autofilled design\", \"data\": {\"cute_pet_image_of_the_day\": {\"type\": \"image\", \"asset_id\": \"Msd59349ff\"}, \"cute_pet_video_of_the_day\": {\"type\": \"video\", \"asset_id\": \"VAHCkrNUANI\"}, \"cute_pet_witty_pet_says\": {\"type\": \"text\", \"text\": \"It was like this when I got here!\"}, \"cute_pet_sales_chart\": {\"type\": \"chart\", \"chart_data\": {\"column_configs\": [{\"name\": \"Geographic Region\", \"type\": \"string\"}, {\"name\": \"Sales (millions AUD)\", \"type\": \"number\"}, {\"name\": \"Target (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\": \"number\", \"value\": 10}, {\"type\": \"boolean\", \"value\": true}, {\"type\": \"date\", \"value\": 1721944387}]}, {\"cells\": [{\"type\": \"string\", \"value\": \"EMEA\"}, {\"type\": \"number\", \"value\": 13.8}, {\"type\": \"number\", \"value\": 14}, {\"type\": \"boolean\", \"value\": false}, {\"type\": \"date\"}]}]}}, \"cute_pet_sales_sheet\": {\"type\": \"sheet\", \"sheet_data\": {\"column_configs\": [{\"name\": \"Geographic Region\", \"type\": \"string\"}, {\"name\": \"Sales (millions AUD)\", \"type\": \"number\"}, {\"name\": \"Target (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\": \"number\", \"value\": 10}, {\"type\": \"boolean\", \"value\": true}, {\"type\": \"date\", \"value\": 1721944387}]}, {\"cells\": [{\"type\": \"string\", \"value\": \"EMEA\"}, {\"type\": \"number\", \"value\": 13.8}, {\"type\": \"number\", \"value\": 14}, {\"type\": \"boolean\", \"value\": false}, {\"type\": \"date\"}]}]}}}}",
Encoding.UTF8,
"application/json"
),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
};
```
```go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
payload := strings.NewReader(`{
"type": "create_from_brand_template",
"brand_template_id": "DAFVztcvd9z",
"title": "My autofilled design",
"data": {
"cute_pet_image_of_the_day": {
"type": "image",
"asset_id": "Msd59349ff"
},
"cute_pet_video_of_the_day": {
"type": "video",
"asset_id": "VAHCkrNUANI"
},
"cute_pet_witty_pet_says": {
"type": "text",
"text": "It was like this when I got here!"
},
"cute_pet_sales_chart": {
"type": "chart",
"chart_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
},
"cute_pet_sales_sheet": {
"type": "sheet",
"sheet_data": {
"column_configs": [
{
"name": "Geographic Region",
"type": "string"
},
{
"name": "Sales (millions AUD)",
"type": "number"
},
{
"name": "Target (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": "number",
"value": 10
},
{
"type": "boolean",
"value": true
},
{
"type": "date",
"value": 1721944387
}
]
},
{
"cells": [
{
"type": "string",
"value": "EMEA"
},
{
"type": "number",
"value": 13.8
},
{
"type": "number",
"value": 14
},
{
"type": "boolean",
"value": false
},
{
"type": "date"
}
]
}
]
}
}
}
}`)
url := "https://api.canva.com/rest/v1/autofills"
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer {token}")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
```
```php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.canva.com/rest/v1/autofills",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer {token}',
'Content-Type: application/json',
),
CURLOPT_POSTFIELDS => json_encode([
"type" => "create_from_brand_template",
"brand_template_id" => "DAFVztcvd9z",
"title" => "My autofilled design",
"data" => [
"cute_pet_image_of_the_day" => [
"type" => "image",
"asset_id" => "Msd59349ff"
],
"cute_pet_video_of_the_day" => [
"type" => "video",
"asset_id" => "VAHCkrNUANI"
],
"cute_pet_witty_pet_says" => [
"type" => "text",
"text" => "It was like this when I got here!"
],
"cute_pet_sales_chart" => [
"type" => "chart",
"chart_data" => [
"column_configs" => [
[
"name" => "Geographic Region",
"type" => "string"
],
[
"name" => "Sales (millions AUD)",
"type" => "number"
],
[
"name" => "Target (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" => "number",
"value" => 10
],
[
"type" => "boolean",
"value" => true
],
[
"type" => "date",
"value" => 1721944387
]
]
],
[
"cells" => [
[
"type" => "string",
"value" => "EMEA"
],
[
"type" => "number",
"value" => 13.8
],
[
"type" => "number",
"value" => 14
],
[
"type" => "boolean",
"value" => false
],
[
"type" => "date"
]
]
]
]
]
],
"cute_pet_sales_sheet" => [
"type" => "sheet",
"sheet_data" => [
"column_configs" => [
[
"name" => "Geographic Region",
"type" => "string"
],
[
"name" => "Sales (millions AUD)",
"type" => "number"
],
[
"name" => "Target (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" => "number",
"value" => 10
],
[
"type" => "boolean",
"value" => true
],
[
"type" => "date",
"value" => 1721944387
]
]
],
[
"cells" => [
[
"type" => "string",
"value" => "EMEA"
],
[
"type" => "number",
"value" => 13.8
],
[
"type" => "number",
"value" => 14
],
[
"type" => "boolean",
"value" => false
],
[
"type" => "date"
]
]
]
]
]
]
]
])
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if (empty($err)) {
echo $response;
} else {
echo "Error: " . $err;
}
```
```ruby
require 'net/http'
require 'uri'
url = URI('https://api.canva.com/rest/v1/autofills')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer {token}'
request['Content-Type'] = 'application/json'
request.body = <
## Success response
If successful, the endpoint returns a `200` response with a JSON body with the following parameters:
Details about the autofill job.
Properties of job} defaultExpanded={true}>
ID of the asynchronous job that is creating the design using the provided data.
Status of the design autofill job.
**Available values:**
* `in_progress`
* `success`
* `failed`
Result of the design autofill job. Only present if job status is `success`.
A new autofilled design has been created and saved to the user's root folder.
**Available values:** The only valid value is `create_design`.
Basic details about the design, such as the design's ID, title, and URL.
Properties of design}>
The design ID.
A temporary set of URLs for viewing or editing the design.
Properties of urls}>
A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
When the design was last updated in Canva, as a Unix timestamp (in seconds since the
Unix Epoch).
The design title.
URL of the design.
A thumbnail image representing the object.
Properties of thumbnail}>
The width of the thumbnail image in pixels.
The height of the thumbnail image in pixels.
A URL for retrieving the thumbnail image.
This URL expires after 15 minutes. This URL includes a query string
that's required for retrieving the thumbnail.
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
WARNING: Trials and trial information are a [preview feature](https://www.canva.dev/docs/apps/rest-apis/#preview-apis).
There might be unannounced breaking changes to this feature which won't produce a new API version.
Trial information for users on a Canva plan that doesn't include autofill access. These
users have a limited number of autofill uses. Once the trial is exhausted, users must
upgrade their Canva plan (such as to Canva Pro, Canva Teams, or Canva Enterprise) to
continue using the Autofill API.
Properties of trial_information}>
The number of uses remaining in the free trial.
The URL for a user to upgrade their Canva account to a plan with autofill access.
The existing design has been autofilled in place.
**Available values:** The only valid value is `update_design`.
Basic details about the design, such as the design's ID, title, and URL.
Properties of design}>
The design ID.
A temporary set of URLs for viewing or editing the design.
Properties of urls}>
A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.
NOTE: This is not a permanent URL, it is only valid for 30 days.
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
Epoch).
When the design was last updated in Canva, as a Unix timestamp (in seconds since the
Unix Epoch).
The design title.
URL of the design.
A thumbnail image representing the object.
Properties of thumbnail}>
The width of the thumbnail image in pixels.
The height of the thumbnail image in pixels.
A URL for retrieving the thumbnail image.
This URL expires after 15 minutes. This URL includes a query string
that's required for retrieving the thumbnail.
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
If the autofill job fails, this object provides details about the error.
Properties of error}>
**Available values:**
* `autofill_error`: The service encountered an error when autofilling your brand template.
* `thumbnail_generation_error`: The service encountered an error when generating a thumbnail for the autofilled design.
* `create_design_error`: The service encountered an error when saving the autofilled design.
* `design_approval_error`: The service encountered an error when applying design approval settings to the autofilled design.
* `trial_quota_exceeded`: The user has exceeded their autofill trial quota.
* `design_update_error`: The service encountered an error when saving the updated design.
A human-readable description of what went wrong.
## Example responses
### In progress job
```json
{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "in_progress"
}
}
```
### Successfully completed job
```json
{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "success",
"result": {
"type": "create_design",
"design": {
"id": "DAFVztcvd9z",
"title": "My summer holiday",
"url": "https://www.canva.com/design/DAFVztcvd9z/edit",
"urls": {
"edit_url": "https://www.canva.com/api/ekimus8HTvsdf&/edit",
"view_url": "https://www.canva.com/api/eylPinTv358hYb8n1U4/view"
},
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?"
},
"created_at": 1586734043,
"updated_at": 1586734043
},
"trial_information": {
"uses_remaining": 2,
"upgrade_url": "https://www.canva.com/pro/"
}
}
}
}
```
### Failed job
```json
{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "failed",
"error": {
"code": "autofill_error",
"message": "Error autofilling design from brand template"
}
}
}
```
## Error responses
### 400 Bad Request
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
A human-readable description of what went wrong.
#### Example error responses
##### The design title specified in the request is not valid.
```json
{
"code": "bad_request_params",
"message": "Design title invalid"
}
```
##### The chart\_data\_processing field value is not yet supported.
```json
{
"code": "bad_request_params",
"message": "The chart_data_processing field is not yet supported"
}
```
##### The brand template ID specified in the request is not a valid ID format.
```json
{
"code": "bad_request_params",
"message": "Invalid brand template ID {brandTemplateId}"
}
```
##### The specified brand template does not contain any autofill capable elements.
```json
{
"code": "design_not_fillable",
"message": "Design does not have any autofill capable elements"
}
```
##### The provided autofill data is not valid for the specified brand template.
```json
{
"code": "autofill_data_invalid",
"message": "{message}"
}
```
### 403 Forbidden
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
A human-readable description of what went wrong.
#### Example error responses
##### The user does not have permission to access the brand template with the ID specified in the request.
```json
{
"code": "permission_denied",
"message": "Not allowed to access brand template with id '{brandTemplateId}'"
}
```
##### The user does not have permission to access the design with the ID specified in the request.
```json
{
"code": "permission_denied",
"message": "Not allowed to access design with id '{designId}'"
}
```
##### The user's plan does not include access to the autofill feature.
```json
{
"code": "permission_denied",
"message": "Access the autofill feature and other powerful design tools by upgrading your Canva plan here: {upgradeUrl}"
}
```
### 404 Not Found
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
A human-readable description of what went wrong.
#### Example error responses
##### A brand template with the ID specified in the request could not be found.
```json
{
"code": "not_found",
"message": "Brand template with id '{brandTemplateId}' not found"
}
```
##### A design with the ID specified in the request could not be found.
```json
{
"code": "not_found",
"message": "Design with id '{designId}' not found"
}
```
### 429 Too Many Requests
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
A human-readable description of what went wrong.
URL to redirect users to upgrade their Canva account and reset their quota.
#### Example error response
##### Feature quota exceeded
```json
{
"code": "quota_exceeded",
"message": "Free autofill quota has been exceeded. Present the `upsell_url` to the user and prompt them to upgrade their Canva account to continue using the autofill feature.",
"upsell_url": "{upsellUrl}"
}
```