Brands

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 users the brand template is shared with (recipient). A successful outcome for this action doesn't guarantee that the message was sent successfully. The message may not be sent for various reasons, including (but not limited to):

The sender was blocklisted by the recipient.
The message contained malicious content.

typestring

The value for this can only be CREATE_BRAND_TEMPLATE_SHARE_MESSAGE.

recipientsShareMessageRecipient[]

The recipient of the share message.

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

Properties of recipients

typestring

This can be one of the following:

USER_RECIPIENT
GROUP_RECIPIENT
ORGANIZATION_RECIPIENT

userAuditLogUser

CONDITIONAL

A Canva user.

Properties of 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.

groupAuditLogGroup

CONDITIONAL

A Canva group.

Properties of group

idstring

The group ID.

display_namestring

OPTIONAL

The display name of the group.

organizationAuditLogOrganization

CONDITIONAL

A Canva organization.

Properties of 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.

messagestring

OPTIONAL

An optional message from the actor to the recipients.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_BRAND_TEMPLATE_SHARE_MESSAGE",
    "message": "Check out my brand template!",
    "recipients": [
      {
        "type": "USER_RECIPIENT",
        "user": {
          "id": "UXoqDbwwSbQ",
          "display_name": "Jane Doe",
          "email": "[email protected]"
        }
      },
      {
        "type": "GROUP_RECIPIENT",
        "group": {
          "id": "GJViWaMsqhL",
          "display_name": "Marketing Group"
        }
      },
      {
        "type": "ORGANIZATION_RECIPIENT",
        "organization": {
          "id": "OXtgecafZvh",
          "display_name": "Acme Corporation"
        }
      }
    ]
  },
  "outcome": ...,
  "context": ...
}

JSON

Brands

Create brand template share message

Example