Brands
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
).
type
string
Default value: SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION
Available values: The only valid value is SEND_BRAND_TEMPLATE_SHARE_NOTIFICATION
.
recipient
ShareNotificationRecipient
The recipient of the share notification.
The recipient can be a user, a group, an organization, or an email address.
Properties of recipient
type
string
This can be one of the following:
USER_RECIPIENT
GROUP_RECIPIENT
ORGANIZATION_RECIPIENT
EMAIL_RECIPIENT
user
AuditLogUser
A Canva user.
Properties of user
id
string
The user ID.
display_name
string
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.
email
string
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.
group
AuditLogGroup
A Canva group.
Properties of group
id
string
The group ID.
display_name
string
The display name of the group.
organization
AuditLogOrganization
A Canva organization.
Properties of organization
id
string
The organization ID.
display_name
string
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.
email
string
The email address the design invite was sent to.
message
string
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",}}},"outcome": ...,"context": ...}