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 apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
AVAILABILITY: To use this API, your app must act on behalf of a user that's on a Canva plan with access to brand templates (such as Canva Pro, Canva Teams, or Canva Enterprise). Additionally, the user must have one of the following roles: Team admin, Brand designer, Organization admin, or Organization designer.
Publishes a design as a brand template. Brand templates are design templates that can be shared across a team for consistent content creation.
This API supports two workflows:
- Initial publish: If the design is not linked to an existing brand template, a new brand template is created.
- Republish: If the design is a draft of an existing brand template (created by editing an existing template), the existing template is updated with the changes.
The API returns the published brand template immediately.
<Note> The `thumbnail` field might be `null` immediately after publishing, as thumbnails are generated asynchronously. You can use the [Get brand template API](https://www.canva.dev/docs/apps/rest-apis/reference/brand-templates/get-brand-template/) to retrieve the thumbnail once it's ready. The brand template's `view_url` and `create_url` are available immediately. </Note>Request
- Base URL: https://api.canva.com/rest
- URL: https://api.canva.com/rest/v1/brand-templates
- Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: brandtemplate:content:write)
Request body
Example request
{
"design_id": "DABCdesign123"
}Response
OK
Example response
{
"brand_template": {
"id": "DEMzWSwy3BI",
"title": "Advertisement Template",
"view_url": "https://www.canva.com/design/DAE35hE8FA4/view",
"create_url": "https://www.canva.com/design/DAE35hE8FA4/remix",
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
},
"created_at": 1704110400,
"updated_at": 1719835200
}
}Changes
- warning
added the new
user_linked_to_another_idpenum value to theresponse property for the response status - warning
added the new
user_linked_to_another_idpenum value to theresponse property for the response status - warning
added the new
user_linked_to_another_idpenum value to theresponse property for the response status - warning
added the new
user_linked_to_another_idpenum value to theresponse property for the response status
- warning
- warning
added the new
asset_not_readyenum value to theresponse property for the response status - warning
added the new
asset_not_readyenum value to theresponse property for the response status - warning
added the new
asset_not_readyenum value to theresponse property for the response status - warning
added the new
asset_not_readyenum value to theresponse property for the response status
- warning