Skip navigation

Skip to main content

Brands

Create a Brand Kit

An actor triggers this event when they create a new Brand Kit. For details, see Canva Help: Setting up Brand Kits⁠(opens in a new tab or window).

typestring

Default value: CREATE_BRAND_KIT

Available values: The only valid value is CREATE_BRAND_KIT.

namestring
Optional

The name of the Brand Kit.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_BRAND_KIT",
    "name": "Acme Corp Brand Kit"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a Brand Kit's details

An actor triggers this event when they update a Brand Kit. For details, see Canva Help: Setting up Brand Kits⁠(opens in a new tab or window).

typestring

Default value: UPDATE_BRAND_KIT

Available values: The only valid value is UPDATE_BRAND_KIT.

changed_fieldsstring[]
Optional

The fields the actor requested changes for in this update.

Available values:

  • NAME: The name of the Brand Kit.
  • SHARES: The shares of the Brand Kit.
  • FONTS: The fonts of the Brand Kit.
  • FOLDER_LINKS: The links to the Brand Kit folders.
  • INGREDIENT: The ingredient of the Brand Kit.
old_namestring
Optional

The previous name of the Brand Kit.

new_namestring
Optional

The new name of the Brand Kit.

old_sharesBrandKitShare[]
Optional

The shares of the Brand Kit.

A team the Brand Kit is shared with.

typestring

Default value: TEAM

Available values: The only valid value is TEAM.

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.

A folder the Brand Kit is shared with.

typestring

Default value: FOLDER

Available values: The only valid value is FOLDER.

folderAuditLogFolder

A Canva folder.

idstring

The folder ID.

namestring
Optional

The name of the folder.

An organization the Brand Kit is shared with.

typestring

Default value: ORGANIZATION

Available values: The only valid value is ORGANIZATION.

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_sharesBrandKitShare[]
Optional

The shares of the Brand Kit.

A team the Brand Kit is shared with.

typestring

Default value: TEAM

Available values: The only valid value is TEAM.

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.

A folder the Brand Kit is shared with.

typestring

Default value: FOLDER

Available values: The only valid value is FOLDER.

folderAuditLogFolder

A Canva folder.

idstring

The folder ID.

namestring
Optional

The name of the folder.

An organization the Brand Kit is shared with.

typestring

Default value: ORGANIZATION

Available values: The only valid value is ORGANIZATION.

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.

old_fontsBrandKitFont[]
Optional

The fonts of the Brand Kit.

idstring

The ID of the font family.

font_familystring
Optional

The name of the font family.

font_stylestring
Optional

The style of the font.

new_fontsBrandKitFont[]
Optional

The fonts of the Brand Kit.

idstring

The ID of the font family.

font_familystring
Optional

The name of the font family.

font_stylestring
Optional

The style of the font.

old_ingredientBrandKitIngredient
Optional

An ingredient of the Brand Kit.

namestring
Optional

A name of the ingredient.

idstring
Optional

ID of the ingredient.

guidelinesstring
Optional

User-provided guidelines to help members of the team understand how, where, and when to use the ingredient.

color_palettesBrandKitColorPalette[]
Optional

The color palettes of the Brand Kit.

namestring
Optional

The name of the color palette.

colorsBrandKitColor[]
Optional

The colors in the palette.

namestring
Optional

The name of the color.

hexstring
Optional

The hex value of the color.

cmykstring
Optional

The CMYK value of the color.

gradientBrandKitGradient
Optional

A color gradient in the Brand Kit.

A linear gradient in the Brand Kit.

typestring

Default value: LINEAR

Available values: The only valid value is LINEAR.

stopsBrandKitGradientStop[]

The color stops in the gradient.

colorstring

The color of the stop.

transparencynumber

The transparency of the stop.

positionnumber

The position of the stop as a percentage along the gradient line.

rotationnumber

The rotation of the gradient in degrees.

A radial gradient in the Brand Kit.

typestring

Default value: RADIAL

Available values: The only valid value is RADIAL.

stopsBrandKitGradientStop[]

The color stops in the gradient.

colorstring

The color of the stop.

transparencynumber

The transparency of the stop.

positionnumber

The position of the stop as a percentage along the gradient line.

centerobject

The center of the radial gradient. If the top and left are both zero, the center is in the top-left of the gradient.

topnumber

The top position of the center, as a percentage down from the top of the gradient.

leftnumber

The left position of the center, as a percentage from the left of the gradient.

text_stylesBrandKitTextStylesGroup[]
Optional

The text styles of the Brand Kit.

namestring

The name of the text style group.

text_stylesBrandKitTextStyle[]

The formatting set for the text style.

fontBrandKitFont

A font in the Brand Kit.

idstring

The ID of the font family.

font_familystring
Optional

The name of the font family.

font_stylestring
Optional

The style of the font.

sizeinteger

The size of the text style in pixels.

namestring
Optional

The name of the text style.

custom_namestring
Optional

The user-defined text style name.

voicestring
Optional

The voice of the brand.

assetsBrandKitAsset[]
Optional

The assets in the ingredient.

idstring

An ID of the asset.

namestring
Optional

A name of the asset.

file_namestring
Optional

A name of the asset file.

new_ingredientBrandKitIngredient
Optional

An ingredient of the Brand Kit.

namestring
Optional

A name of the ingredient.

idstring
Optional

ID of the ingredient.

guidelinesstring
Optional

User-provided guidelines to help members of the team understand how, where, and when to use the ingredient.

color_palettesBrandKitColorPalette[]
Optional

The color palettes of the Brand Kit.

namestring
Optional

The name of the color palette.

colorsBrandKitColor[]
Optional

The colors in the palette.

namestring
Optional

The name of the color.

hexstring
Optional

The hex value of the color.

cmykstring
Optional

The CMYK value of the color.

gradientBrandKitGradient
Optional

A color gradient in the Brand Kit.

A linear gradient in the Brand Kit.

typestring

Default value: LINEAR

Available values: The only valid value is LINEAR.

stopsBrandKitGradientStop[]

The color stops in the gradient.

colorstring

The color of the stop.

transparencynumber

The transparency of the stop.

positionnumber

The position of the stop as a percentage along the gradient line.

rotationnumber

The rotation of the gradient in degrees.

A radial gradient in the Brand Kit.

typestring

Default value: RADIAL

Available values: The only valid value is RADIAL.

stopsBrandKitGradientStop[]

The color stops in the gradient.

colorstring

The color of the stop.

transparencynumber

The transparency of the stop.

positionnumber

The position of the stop as a percentage along the gradient line.

centerobject

The center of the radial gradient. If the top and left are both zero, the center is in the top-left of the gradient.

topnumber

The top position of the center, as a percentage down from the top of the gradient.

leftnumber

The left position of the center, as a percentage from the left of the gradient.

text_stylesBrandKitTextStylesGroup[]
Optional

The text styles of the Brand Kit.

namestring

The name of the text style group.

text_stylesBrandKitTextStyle[]

The formatting set for the text style.

fontBrandKitFont

A font in the Brand Kit.

idstring

The ID of the font family.

font_familystring
Optional

The name of the font family.

font_stylestring
Optional

The style of the font.

sizeinteger

The size of the text style in pixels.

namestring
Optional

The name of the text style.

custom_namestring
Optional

The user-defined text style name.

voicestring
Optional

The voice of the brand.

assetsBrandKitAsset[]
Optional

The assets in the ingredient.

idstring

An ID of the asset.

namestring
Optional

A name of the asset.

file_namestring
Optional

A name of the asset file.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_BRAND_KIT",
    "changed_fields": [
      "NAME",
      "SHARES",
      "FONTS",
      "FOLDER_LINKS",
      "INGREDIENT"
    ],
    "old_name": "Marketing Brand Kit",
    "new_name": "Growth Brand Kit",
    "old_shares": [
      {
        "type": "TEAM",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "FOLDER",
        "folder": {
          "id": "FXeFatjDhdR",
          "name": "Marketing Folder"
        }
      },
      {
        "type": "ORGANIZATION",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      }
    ],
    "new_shares": [
      {
        "type": "TEAM",
        "team": {
          "id": "BXeFatjDhdR",
          "display_name": "Acme Team"
        }
      },
      {
        "type": "FOLDER",
        "folder": {
          "id": "FXeFatjDhdR",
          "name": "Marketing Folder"
        }
      },
      {
        "type": "ORGANIZATION",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      }
    ],
    "old_fonts": [
      "Roboto Thin",
      "Mona Sans"
    ],
    "new_fonts": [
      "Roboto Thin",
      "Mona Sans"
    ],
    "old_folder_links": [
      {
        "folder": {
          "id": "FXeFatjDhdR",
          "name": "Marketing Folder"
        },
        "type": "CHARTS"
      }
    ],
    "new_folder_links": [
      {
        "folder": {
          "id": "FXeFatjDhdR",
          "name": "Marketing Folder"
        },
        "type": "CHARTS"
      }
    ],
    "old_ingredient": {
      "name": "Colors",
      "id": "IG-123456789000",
      "guidelines": "Use these colors for all marketing materials.",
      "color_palettes": [
        {
          "name": "Main brand colors",
          "colors": [
            {
              "name": "Primary",
              "hex": "#FF0000",
              "cmyk": "cmyk(0, 100, 100, 0)",
              "gradient": {
                "type": "LINEAR",
                "stops": [
                  {
                    "color": "#FF0000",
                    "transparency": 0.5,
                    "position": 50
                  }
                ],
                "rotation": 90
              }
            }
          ]
        }
      ],
      "text_styles": [
        {
          "name": "Title",
          "text_styles": [
            {
              "name": "Title",
              "font": {
                "id": "YXeFatjDhdR",
                "font_family": "Roboto",
                "font_style": "Bold"
              },
              "custom_name": "Main Title",
              "size": 12
            }
          ]
        }
      ],
      "voice": "Our voice is professional and formal.",
      "assets": [
        {
          "id": "M1234567890",
          "name": "Our primary logo",
          "file_name": "main-logo.png"
        }
      ]
    },
    "new_ingredient": {
      "name": "Colors",
      "id": "IG-123456789000",
      "guidelines": "Use these colors for all marketing materials.",
      "color_palettes": [
        {
          "name": "Main brand colors",
          "colors": [
            {
              "name": "Primary",
              "hex": "#FF0000",
              "cmyk": "cmyk(0, 100, 100, 0)",
              "gradient": {
                "type": "LINEAR",
                "stops": [
                  {
                    "color": "#FF0000",
                    "transparency": 0.5,
                    "position": 50
                  }
                ],
                "rotation": 90
              }
            }
          ]
        }
      ],
      "text_styles": [
        {
          "name": "Title",
          "text_styles": [
            {
              "name": "Title",
              "font": {
                "id": "YXeFatjDhdR",
                "font_family": "Roboto",
                "font_style": "Bold"
              },
              "custom_name": "Main Title",
              "size": 12
            }
          ]
        }
      ],
      "voice": "Our voice is professional and formal.",
      "assets": [
        {
          "id": "M1234567890",
          "name": "Our primary logo",
          "file_name": "main-logo.png"
        }
      ]
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Delete a Brand Kit

An actor triggers this event when they delete a Brand Kit. For details, see Canva Help: Setting up Brand Kits⁠(opens in a new tab or window).

typestring

Default value: DELETE_BRAND_KIT

Available values: The only valid value is DELETE_BRAND_KIT.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "DELETE_BRAND_KIT"
  },
  "outcome": ...,
  "context": ...
}
JSON

Send a brand template share notification

An actor triggers this event when they share a brand template. Canva will attempt to send an email and an in-app notification to the user the brand template is shared with (recipient).

typestring

Default value: SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION

Available values: The only valid value is SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION.

recipientShareNotificationRecipient

The recipient of the share notification.

The recipient can be a user, a group, an organization, or an email address.

typestring

Default value: USER_RECIPIENT

Available values: The only valid value is USER_RECIPIENT.

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.

typestring

Default value: GROUP_RECIPIENT

Available values: The only valid value is GROUP_RECIPIENT.

groupAuditLogGroup

A Canva group.

idstring

The group ID.

display_namestring
Optional

The display name of the group.

typestring

Default value: ORGANIZATION_RECIPIENT

Available values: The only valid value is ORGANIZATION_RECIPIENT.

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.

typestring

Default value: EMAIL_RECIPIENT

Available values: The only valid value is EMAIL_RECIPIENT.

emailstring

The email address the design invite was sent to.

messagestring
Optional

An optional message from the actor to the recipient.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION",
    "message": "Check out my brand template!",
    "recipient": {
      "type": "USER_RECIPIENT",
      "user": {
        "id": "UXoqDbwwSbQ",
        "display_name": "Jane Doe",
        "email": "[email protected]"
      }
    }
  },
  "outcome": ...,
  "context": ...
}
JSON