Skip navigation

Skip to main content

Templates

Publish a template

An actor triggers this event when they publish a template

typestring

Default value: PUBLISH_TEMPLATE

Available values: The only valid value is PUBLISH_TEMPLATE.

template_typestring
Optional

The type of a template

Available values:

  • DESIGN: A design template
  • ELEMENT: An element template
template_domainstring
Optional

The domain of a template

Available values: The only valid value is BRAND: Brand domain.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "PUBLISH_TEMPLATE",
    "template_type": "DESIGN",
    "template_domain": "BRAND"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a template's details

An actor triggers this event when they update a template

typestring

Default value: UPDATE_TEMPLATE

Available values: The only valid value is UPDATE_TEMPLATE.

template_typestring
Optional

The type of a template

Available values:

  • DESIGN: A design template
  • ELEMENT: An element template
template_domainstring
Optional

The domain of a template

Available values: The only valid value is BRAND: Brand domain.

new_titlestring
Optional

The new title of the template

old_titlestring
Optional

The old title of the template.

new_descriptionstring
Optional

The new description of the template

old_descriptionstring
Optional

The old description of the template.

new_keywordsstring[]
Optional

The new keywords of the template

old_keywordsstring[]
Optional

The old keywords of the template

changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values:

  • TITLE: The template's title
  • DESCRIPTION: The template's description
  • KEYWORDS: The template's keywords

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_TEMPLATE",
    "template_type": "DESIGN",
    "template_domain": "BRAND",
    "new_title": "New Instagram Template",
    "old_title": "Old Instagram Template",
    "new_description": "An new Instagram template",
    "old_description": "An old Instagram template",
    "new_keywords": [
      "festival",
      "halloween"
    ],
    "old_keywords": [
      "festival",
      "christmas"
    ],
    "changed_fields": [
      "TITLE",
      "DESCRIPTION"
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete a template

An actor triggers this event when they delete a template.

typestring

Default value: DELETE_TEMPLATE

Available values: The only valid value is DELETE_TEMPLATE.

template_typestring
Optional

The type of a template

Available values:

  • DESIGN: A design template
  • ELEMENT: An element template
template_domainstring
Optional

The domain of a template

Available values: The only valid value is BRAND: Brand domain.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "DELETE_TEMPLATE",
    "template_type": "DESIGN",
    "template_domain": "BRAND"
  },
  "outcome": ...,
  "context": ...
}
JSON

Restore a deleted template

An actor triggers this event when they restore a deleted template.

typestring

Default value: UNDELETE_TEMPLATE

Available values: The only valid value is UNDELETE_TEMPLATE.

template_typestring
Optional

The type of a template

Available values:

  • DESIGN: A design template
  • ELEMENT: An element template
template_domainstring
Optional

The domain of a template

Available values: The only valid value is BRAND: Brand domain.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UNDELETE_TEMPLATE",
    "template_type": "DESIGN",
    "template_domain": "BRAND"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a template's access controls

An actor triggers this event when they update the access control list of a template.

typestring

Default value: UPDATE_TEMPLATE_ACCESS_CONTROLS

Available values: The only valid value is UPDATE_TEMPLATE_ACCESS_CONTROLS.

changesTemplateAccessControlChange[]

List of access control changes made to the template

Grant template access to a user

typestring

Default value: GRANT_USER_TEMPLATE_ACCESS

Available values: The only valid value is GRANT_USER_TEMPLATE_ACCESS.

userAuditLogUser

A Canva user.

idstring

The user ID.

display_namestring
Optional

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
Optional

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Revoke template access from a user

typestring

Default value: REVOKE_USER_TEMPLATE_ACCESS

Available values: The only valid value is REVOKE_USER_TEMPLATE_ACCESS.

userAuditLogUser

A Canva user.

idstring

The user ID.

display_namestring
Optional

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
Optional

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Update template access from a user

typestring

Default value: UPDATE_USER_TEMPLATE_ACCESS

Available values: The only valid value is UPDATE_USER_TEMPLATE_ACCESS.

userAuditLogUser

A Canva user.

idstring

The user ID.

display_namestring
Optional

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring
Optional

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

new_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

old_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Grant template access to a team

typestring

Default value: GRANT_TEAM_TEMPLATE_ACCESS

Available values: The only valid value is GRANT_TEAM_TEMPLATE_ACCESS.

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team

Revoke template access from a team

typestring

Default value: REVOKE_TEAM_TEMPLATE_ACCESS

Available values: The only valid value is REVOKE_TEAM_TEMPLATE_ACCESS.

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team

Update template access for a team

typestring

Default value: UPDATE_TEAM_TEMPLATE_ACCESS

Available values: The only valid value is UPDATE_TEAM_TEMPLATE_ACCESS.

teamAuditLogTeam

A Canva team.

idstring

The team ID.

display_namestring
Optional

The display name of the team.

For privacy reasons, this field is redacted for brands outside of your organization. Rarely, it may be unavailable for technical reasons.

new_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

old_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team

Grant template access to a group

typestring

Default value: GRANT_GROUP_TEMPLATE_ACCESS

Available values: The only valid value is GRANT_GROUP_TEMPLATE_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Revoke template access from a group

typestring

Default value: REVOKE_GROUP_TEMPLATE_ACCESS

Available values: The only valid value is REVOKE_GROUP_TEMPLATE_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Update template access from a group

typestring

Default value: UPDATE_GROUP_TEMPLATE_ACCESS

Available values: The only valid value is UPDATE_GROUP_TEMPLATE_ACCESS.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

new_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

old_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

Grant template access to an organization

typestring

Default value: GRANT_ORGANIZATION_TEMPLATE_ACCESS

Available values: The only valid value is GRANT_ORGANIZATION_TEMPLATE_ACCESS.

organizationAuditLogOrganization

A Canva organization.

idstring

The organization ID.

display_namestring
Optional

The display name of the organization.

For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team

Revoke template access from an organization

typestring

Default value: REVOKE_ORGANIZATION_TEMPLATE_ACCESS

Available values: The only valid value is REVOKE_ORGANIZATION_TEMPLATE_ACCESS.

organizationAuditLogOrganization

A Canva organization.

idstring

The organization ID.

display_namestring
Optional

The display name of the organization.

For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.

accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team

Update template access for an organization

typestring

Default value: UPDATE_ORGANIZATION_TEMPLATE_ACCESS

Available values: The only valid value is UPDATE_ORGANIZATION_TEMPLATE_ACCESS.

organizationAuditLogOrganization

A Canva organization.

idstring

The organization ID.

display_namestring
Optional

The display name of the organization.

For privacy reasons, this field is redacted for organizations other than your organization. Rarely, it may be unavailable for technical reasons.

new_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

old_accessTemplateAccessLevel

Template access level

readboolean

Whether the user can view the template.

writeboolean

Whether the user can edit the template content.

share_view_accessboolean

Whether the user can share the template with others to view.

share_edit_accessboolean

Whether the user can share the template with others view and edit.

deleteboolean

Whether the user can delete the template.

rolestring
Optional

Identity context roles assignable to access control principals

Available values:

  • ORGANIZATION_ADMIN: The admin of the organization
  • ORGANIZATION_TEAM_MANAGER: The team manager of the organization
  • TEAM_OWNER: The owner of the team
  • TEAM_ADMIN: The admin of the team
  • TEAM_DESIGNER: The designer of the team
template_typestring
Optional

The type of a template

Available values:

  • DESIGN: A design template
  • ELEMENT: An element template
template_domainstring
Optional

The domain of a template

Available values: The only valid value is BRAND: Brand domain.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_TEMPLATE_ACCESS_CONTROLS",
    "template_type": "DESIGN",
    "template_domain": "BRAND",
    "changes": [
      {
        "type": "GRANT_USER_TEMPLATE_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_USER_TEMPLATE_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "UPDATE_USER_TEMPLATE_ACCESS",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        },
        "new_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        },
        "old_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "GRANT_TEAM_TEMPLATE_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "role": "ORGANIZATION_ADMIN",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_TEAM_TEMPLATE_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "role": "ORGANIZATION_ADMIN",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "UPDATE_TEAM_TEMPLATE_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "role": "ORGANIZATION_ADMIN",
        "new_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        },
        "old_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "GRANT_GROUP_TEMPLATE_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_GROUP_TEMPLATE_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "UPDATE_GROUP_TEMPLATE_ACCESS",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        },
        "new_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        },
        "old_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "GRANT_ORGANIZATION_TEMPLATE_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        },
        "role": "ORGANIZATION_ADMIN",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_ORGANIZATION_TEMPLATE_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        },
        "role": "ORGANIZATION_ADMIN",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "UPDATE_ORGANIZATION_TEMPLATE_ACCESS",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        },
        "role": "ORGANIZATION_ADMIN",
        "new_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        },
        "old_access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "GRANT_PUBLIC_LINK_TEMPLATE_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_PUBLIC_LINK_TEMPLATE_ACCESS",
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "GRANT_TEAM_LINK_TEMPLATE_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      },
      {
        "type": "REVOKE_TEAM_LINK_TEMPLATE_ACCESS",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        },
        "access": {
          "read": true,
          "write": true,
          "share_view_access": true,
          "share_edit_access": true,
          "delete": true
        }
      }
    ]
  },
  "outcome": ...,
  "context": ...
}
JSON