Canva

canva

Canva offers a drag-and-drop design suite for creating social media graphics, presentations, and marketing materials with prebuilt templates and a vast element library

Images & Design Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (32)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Access user specific brand templates listCANVA_ACCESS_USER_SPECIFIC_BRAND_TEMPLATES_LISTAcción

This year, brand template ids will change; integrations storing them must update within 6 months. also, api use requires canva enterprise membership.

Parámetros de entrada

querystring
Lets you search the brand templates available to the user using a search term or terms.
datasetstringenum
Filter the list of brand templates based on the brand templates" dataset definitions. Brand templates with dataset definitions are mainly used with the [Autofill APIs](https://www.canva.dev/docs/connect/api-reference/autofills/). This can be one of the following: - `any`: (Default) Brand templates with and without dataset definitions. - `non_empty`: Brand templates with one or more data fields defined. - `empty`: Brand templates with no data fields defined.
anynon_emptyempty
sort_bystringenum
Sort the list of brand templates. This can be one of the following: - `relevance`: (Default) Sort results using a relevance algorithm. - `modified_descending`: Sort results by the date last modified in descending order. - `modified_ascending`: Sort results by the date last modified in ascending order. - `title_descending`: Sort results by title in descending order. - `title_ascending`: Sort results by title in ascending order.
relevancemodified_descendingmodified_ascendingtitle_descendingtitle_ascending
ownershipstringenum
Filter the list of brand templates based on the user"s ownership of the brand templates. This can be one of the following: - `any`: (Default) Brand templates owned by and shared with the user. - `owned`: Brand templates owned by the user. - `shared`: Brand templates shared with the user.
anyownedshared
continuationstring
If the success response contains a continuation token, the user has access to more brand templates you can list. You can use this token as a query parameter and retrieve more templates from the list, for example `/v1/brand-templates?continuation={continuation}`. To retrieve all the brand templates available to the user, you might need to make multiple requests.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create canva design with optional assetCANVA_CREATE_CANVA_DESIGN_WITH_OPTIONAL_ASSETAcción

Create a new canva design using a preset or custom dimensions, and add an asset with `asset id` from a user's project using relevant apis.

Parámetros de entrada

titlestring
The name of the design. Must be less than 256 characters.
asset_idstring
The ID of an asset to insert into the created design.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create comment reply in designCANVA_CREATE_COMMENT_REPLY_IN_DESIGNAcción

This preview api allows replying to comments within a design on canva, with a limit of 100 replies per comment. users should note potential unannounced changes, and that preview apis are not eligible for public integrations.

Parámetros de entrada

messagestringObligatorio
The reply comment message. This is the reply comment body shown in the Canva UI. You can also mention users in your message by specifying their User ID and Team ID using the format `[user_id:team_id]`.
commentIdstringObligatorio
The `id` of the comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create design comment in preview apiCANVA_CREATE_DESIGN_COMMENT_IN_PREVIEW_APIAcción

This api is in preview and may change without notice; integrations using it won't pass review. it allows creating comments on a design, with a limit of 1000 comments per design.

Parámetros de entrada

messagestringObligatorio
The comment message. This is the comment body shown in the Canva UI. You can also mention users in your message by specifying their User ID and Team ID using the format `[user_id:team_id]`. If the `assignee_id` parameter is specified, you must mention the assignee in the message.
assignee_idstring
Lets you assign the comment to a Canva user using their User ID. You _must_ mention the assigned user in the `message`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create user or sub folderCANVA_CREATE_USER_OR_SUB_FOLDERAcción

This api creates a folder in a canva user's projects at the top level or within another folder, returning the new folder's id and additional details upon success.

Parámetros de entrada

namestringObligatorio
The name of the folder. Must be less than 256 characters.
parent_folder_idstringObligatorio
The folder ID of the parent folder. To create a new folder at the top level of a user"s [projects](https://www.canva.com/help/find-designs-and-folders/), use the ID `root`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete asset by idCANVA_DELETE_ASSET_BY_IDAcción

You can delete an asset by specifying its `assetid`. this operation mirrors the behavior in the canva ui. deleting an item moves it to the trash. deleting an asset doesn't remove it from designs that already use it.

Parámetros de entrada

assetIdstringObligatorio
The ID of the asset.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Exchange oauth 2 0 access or refresh tokenCANVA_EXCHANGE_OAUTH20_ACCESS_OR_REFRESH_TOKENAcción

The oauth 2.0 endpoint issues time-limited (4-hour) access tokens of up to 4kb for user authorization via codes or refresh tokens. it requires client id/secret for authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch asset upload job statusCANVA_FETCH_ASSET_UPLOAD_JOB_STATUSAcción

Summarize asset upload outcome by repeatedly calling the endpoint until a 'success' or 'failed' status is received after using the create asset upload job api.

Parámetros de entrada

jobIdstringObligatorio
The asset upload job ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch canva connect signing public keysCANVA_FETCH_CANVA_CONNECT_SIGNING_PUBLIC_KEYSAcción

The api for verifying canva webhooks, 'connect/keys,' is in preview, meaning unstable, not for public integrations, and provides a rotating jwk for signature verification to prevent replay attacks. cache keys for efficiency.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch current user detailsCANVA_FETCH_CURRENT_USER_DETAILSAcción

Returns the user id, team id, and display name of the user account associated with the provided access token.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch design metadata and access informationCANVA_FETCH_DESIGN_METADATA_AND_ACCESS_INFORMATIONAcción

Gets the metadata for a design. this includes owner information, urls for editing and viewing, and thumbnail information.

Parámetros de entrada

designIdstringObligatorio
The design ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get design export job resultCANVA_GET_DESIGN_EXPORT_JOB_RESULTAcción

Get the outcome of a canva design export job; if done, receive download links for the design’s pages. for details, visit the create design export job api documentation.

Parámetros de entrada

exportIdstringObligatorio
The export job ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Initiate canva design autofill jobCANVA_INITIATE_CANVA_DESIGN_AUTOFILL_JOBAcción

Upcoming brand template id updates require migration within 6 months. canva enterprise users can auto-fill designs using various data types, including experimental chart data. monitor jobs with specific api.

Parámetros de entrada

dataobjectObligatorio
Data object containing the data fields and values to autofill.
titlestring
Title to use for the autofilled design. Must be less than 256 characters. If no design title is provided, the autofilled design will have the same title as the brand template.
brand_template_idstringObligatorio
ID of the input brand template.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Initiates canva design export jobCANVA_INITIATES_CANVA_DESIGN_EXPORT_JOBAcción

Canva's new job feature exports designs in multiple formats using a design id, with provided download links. the export status can be tracked via an api. exports with 'pro' quality may fail if the design contains unpaid premium elements.

Parámetros de entrada

design_idstringObligatorio
The design ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List design pages with paginationCANVA_LIST_DESIGN_PAGES_WITH_PAGINATIONAcción

Preview api for canva: subject to unannounced changes and not for public integrations. lists metadata for design pages with optional `offset` and `limit`; not applicable to all design types.

Parámetros de entrada

limitinteger
The number of pages to return, starting at the page index specified using the `offset` parameter. Default is `50` pages.
offsetinteger
The page index to start the range of pages to return. Default is `1`. Pages are indexed using one-based numbering, so the first page in a design has the index value `1`.
designIdstringObligatorio
The design ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List folder items by type with sortingCANVA_LIST_FOLDER_ITEMS_BY_TYPE_WITH_SORTINGAcción

Lists the items in a folder, including each item's `type`. folders can contain: - other folders. - designs, such as instagram posts, presentations, and documents ([canva docs](https://www.canva.com/create/documents/)). - image assets.

Parámetros de entrada

sort_bystringenum
Sort the list of folder items. This can be one of the following: - `created_ascending`: Sort results by creation date, in ascending order. - `created_descending`: Sort results by creation date, in descending order. - `modified_ascending`: Sort results by the last modified date, in ascending order. - `modified_descending`: (Default) Sort results by the last modified date, in descending order. - `title_ascending`: Sort results by title, in ascending order. The title is either the `name` field for a folder or asset, or the `title` field for a design. - `title_descending`: Sort results by title, in descending order. The title is either the `name` field for a folder or asset, or the `title` field for a design.
created_ascendingcreated_descendingmodified_ascendingmodified_descendingtitle_ascendingtitle_descending
folderIdstringObligatorio
The folder ID.
item_typesstring[]
Filter the folder items to only return specified types. The available types are: `design`, `folder`, and `image`. To filter for more than one item type, provide a comma- delimited list.
continuationstring
If the success response contains a continuation token, the folder contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example `/v1/folders/{folderId}/items?continuation={continuation}`. To retrieve all the items in a folder, you might need to make multiple requests.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List User DesignsCANVA_LIST_USER_DESIGNSAcción

Provides a summary of canva user designs, includes search filtering, and allows showing both self-created and shared designs with sorting options.

Parámetros de entrada

querystring
Lets you search the user"s designs, and designs shared with the user, using a search term or terms.
sort_bystringenum
Sort the list of designs. This can be one of the following: - `relevance`: (Default) Sort results using a relevance algorithm. - `modified_descending`: Sort results by the date last modified in descending order. - `modified_ascending`: Sort results by the date last modified in ascending order. - `title_descending`: Sort results by title in descending order. - `title_ascending`: Sort results by title in ascending order.
relevancemodified_descendingmodified_ascendingtitle_descendingtitle_ascending
ownershipstringenum
Filter the list of designs based on the user"s ownership of the designs. This can be one of the following: - `owned`: Designs owned by the user. - `shared`: Designs shared with the user. - `any`: Designs owned by and shared with the user.
anyownedshared
continuationstring
If the success response contains a continuation token, the list contains more designs you can list. You can use this token as a query parameter and retrieve more designs from the list, for example `/v1/designs?continuation={continuation}`. To retrieve all of a user"s designs, you might need to make multiple requests.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move item to specified folderCANVA_MOVE_ITEM_TO_SPECIFIED_FOLDERAcción

Transfers an item to a different folder by specifying both the destination folder's id and the item's id. if the item is in various folders, an error occurs; manual relocation via canva ui is required.

Parámetros de entrada

item_idstringObligatorio
The ID of the item you want to move.
to_folder_idstringObligatorio
The ID of the folder you want to move the item to (the destination folder). If you want to move the item to the top level of a Canva user"s [projects](https://www.canva.com/help/find-designs-and-folders/), use the ID `root`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove folder and move contents to trashCANVA_REMOVE_FOLDER_AND_MOVE_CONTENTS_TO_TRASHAcción

Deletes a folder by moving the user's content to trash and reassigning other users' content to their top-level projects.

Parámetros de entrada

folderIdstringObligatorio
The folder ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve app public key setCANVA_RETRIEVE_APP_PUBLIC_KEY_SETAcción

Returns the json web key set (public keys) of an app. these keys are used to verify jwts sent to app backends.

Parámetros de entrada

appIdstringObligatorio
The app id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a specific design commentCANVA_RETRIEVE_A_SPECIFIC_DESIGN_COMMENTAcción

This preview api is subject to unannounced changes and can't be used in public integrations. it retrieves a comment, details of which are on canva help center.

Parámetros de entrada

designIdstringObligatorio
The design ID.
commentIdstringObligatorio
The `id` of the comment.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve asset metadata by idCANVA_RETRIEVE_ASSET_METADATA_BY_IDAcción

You can retrieve the metadata of an asset by specifying its `assetid`.

Parámetros de entrada

assetIdstringObligatorio
The ID of the asset.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve brand template dataset definitionCANVA_RETRIEVE_BRAND_TEMPLATE_DATASET_DEFINITIONAcción

Canva's brand template ids will change later this year, including a 6-month integration migration. api access requires enterprise membership, providing autofill for images, text, and charts, although chart data could change during preview.

Parámetros de entrada

brandTemplateIdstringObligatorio
The brand template ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve canva enterprise brand template metadataCANVA_RETRIEVE_CANVA_ENTERPRISE_BRAND_TEMPLATE_METADATAAcción

Upcoming update will change brand template ids; integrations must migrate within 6 months. api use requires canva enterprise membership.

Parámetros de entrada

brandTemplateIdstringObligatorio
The brand template ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve design autofill job statusCANVA_RETRIEVE_DESIGN_AUTOFILL_JOB_STATUSAcción

Api users with canva enterprise membership can retrieve design autofill job results, potentially requiring multiple requests until a `success` or `failed` status is received.

Parámetros de entrada

jobIdstringObligatorio
The design autofill job ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve design import job statusCANVA_RETRIEVE_DESIGN_IMPORT_JOB_STATUSAcción

Gets the status and results of design import jobs created using the [create design import job api](https://www.canva.dev/docs/connect/api-reference/design-imports/create-design-import-job/).

Parámetros de entrada

jobIdstringObligatorio
The design import job ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve folder details by idCANVA_RETRIEVE_FOLDER_DETAILS_BY_IDAcción

Gets the name and other details of a folder using a folder's `folderid`.

Parámetros de entrada

folderIdstringObligatorio
The folder ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

RetrieveuserprofiledataCANVA_RETRIEVE_USER_PROFILE_DATAAcción

Currently, this returns the display name of the user account associated with the provided access token. more user information is expected to be included in the future.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Revoke oauth tokensCANVA_REVOKE_OAUTH_TOKENSAcción

Revoke a refresh token to end its lineage and user consent, requiring re-authentication. authenticate using either basic access with base64-encoded credentials or body parameters with client id and secret.

Parámetros de entrada

tokenstringObligatorio
The token to revoke.
client_idstring
Your integration"s unique ID, for authenticating the request. NOTE: We recommend that you use basic access authentication instead of specifying `client_id` and `client_secret` as body parameters.
client_secretstring
Your integration"s client secret, for authenticating the request. Begins with `cnvca`. NOTE: We recommend that you use basic access authentication instead of specifying `client_id` and `client_secret` as body parameters.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update asset s name and tags by idCANVA_UPDATE_ASSET_S_NAME_AND_TAGS_BY_IDAcción

You can update the name and tags of an asset by specifying its `assetid`. updating the tags replaces all existing tags of the asset.

Parámetros de entrada

namestring
The name of the asset. This is shown in the Canva UI. When this field is undefined, nothing is updated. Maximum length 50 characters.
tagsstring[]
The replacement tags for the asset. When this field is undefined, nothing is updated. Maximum length 50 tags. Each tag has a maximum length of 50 characters.
assetIdstringObligatorio
The ID of the asset.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update folder details by idCANVA_UPDATE_FOLDER_DETAILS_BY_IDAcción

Updates a folder's details using its `folderid`. currently, you can only update a folder's name.

Parámetros de entrada

namestringObligatorio
The folder name, as shown in the Canva UI.
folderIdstringObligatorio
The folder ID.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Validate oauth token propertiesCANVA_VALIDATE_OAUTH_TOKEN_PROPERTIESAcción

Check an access token's validity and properties via introspection, requiring authentication. use basic access (base64 encoded `client id:client secret`) or body parameters for credentialing.

Parámetros de entrada

tokenstringObligatorio
The token to introspect.
client_idstring
Your integration"s unique ID, for authenticating the request. NOTE: We recommend that you use basic access authentication instead of specifying `client_id` and `client_secret` as body parameters.
client_secretstring
Your integration"s client secret, for authenticating the request. Begins with `cnvca`. NOTE: We recommend that you use basic access authentication instead of specifying `client_id` and `client_secret` as body parameters.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not