Changelog
- The Autofill APIs now return a
page_count
property for multi-page designs in a successful job. - The Design import APIs now return a
page_count
property for multi-page designs in a successful job. - The List folder items API now returns a
page_count
property for all multi-page designs in the requested folder. - Webhook notification events now return a
page_count
property in the design summary for all multi-page designs.
- A new preview API is available: Get design export formats. This API lets you retrieve a list of supported file formats that can be used to export a design.
- Webhook notification events for suggestions (suggested edits in a Canva Doc) are now sent to integrations that have notifications enabled. See Suggestion notifications for details.
- A new preview API is available: Get design pages. This API lets you retrieve per-page metadata, which currently includes page-specific thumbnails.
-
The Design import APIs are no longer in preview, and are now generally available.
-
The Folders APIs are no longer in preview, and are now generally available.
- The List brand templates API now supports an optional
dataset
query parameter. This can be used to filter results to only include brand templates with or without data fields defined (for use with the Autofill APIs).
- The Create design autofill job API now accepts data values for
chart
data fields, which lets you autofill tabular data for chart elements. Chart data fields are currently a preview feature. - The Get brand template dataset API now returns
chart
data fields for brand templates which contain chart elements. Chart elements and data fields in brand templates are created using the Data autofill app. Chart data fields are currently a preview feature. - The responses for the preview Design import APIs have been revised to align with the response formats used by our other asynchronous job APIs.
- Previously, the
created_at
property in the preview feature for webhook payloads was incorrectly returned as milliseconds since the UNIX epoch. This has been fixed, socreated_at
now correctly represents seconds since the UNIX epoch.
-
The Designs APIs now return a
page_count
property. -
When using the Create design export job API to export designs as a PNG, the
lossless
parameter is now set totrue
by default.We made this change to the default value without creating a new API version because the previous behavior was a bug that significantly affected the user experience. Lossy PNG compression is a premium feature, and under the previous default value for the parameter, users on the Canva Free plan could not export to PNG.
-
The List folder items preview API now returns
image
instead ofasset
. Theasset
option in theitem_types
filter has also been replaced withimage
.
-
For the List folder items preview API, the response for the
design
object type no longer includesowner
information. -
The List folder items preview API no longer accepts
template
as query parameter foritem_types
, and no longer returnstemplate
orbrand_template
item types in the response. -
In the Move folder item preview API, the
from_folder_id
parameter has been removed.
- The Assets APIs now return an additional
type
property as part of theasset
object. Currently,type
can only have the value ofimage
, but more asset types are being added in future updates.
- The Autofill APIs now return
created_at
andupdated_at
timestamps in the design summary for jobs with asuccess
status. Temporaryurls
for viewing or editing the design have also been added to the response.
- The Brand template APIs now return
created_at
andupdated_at
timestamps for all brand templates. - The Designs APIs now return
created_at
andupdated_at
timestamps for all returned designs. - The Get design import job API now returns
created_at
andupdated_at
timestamps for designs imported using the Create design import job API. - The List folder items API now returns
created_at
andupdated_at
timestamps for all designs in the requested folder.
- The Autofill APIs are no longer in preview, and are now generally available.
- The Brand template APIs are no longer in preview, and are now generally available.
New API version: 2024-06-18
- Initial release of the Connect APIs.