Skip navigation

Skip to main content

Organizations

Update an organization's details

An actor triggers this event when they update the details of a Canva organization, such as the organization's display name.

typestring

Default value: UPDATE_ORGANIZATION

Available values: The only valid value is UPDATE_ORGANIZATION.

changed_fieldsstring[]
Optional

Fields requested to be changed in this update.

Available values:

  • ORGANIZATION_NAME: The name of the organization.
  • DEFAULT_TEAM: The team to provision users into by default.
  • DEFAULT_TEAM_POLICY: The policy for determining if a user can be provisioned into a default team.
old_namestring
Optional

The previous name of the organization.

new_namestring
Optional

The new name of the organization.

default_teamAuditLogTeam
Optional

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.

default_team_policystring
Optional

The policy for determining if a user can be provisioned into a default team.

Available values:

  • ADMIN_AND_UP: Users with the ADMIN organization role or higher are added to the team.
  • DESIGNER_AND_UP: Users with the DESIGNER organization role or higher are added to the team.
  • MEMBER_AND_UP: Users with the MEMBER organization role or higher are added to the team.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_ORGANIZATION",
    "changed_fields": [
      "ORGANIZATION_NAME",
      "DEFAULT_TEAM",
      "DEFAULT_TEAM_POLICY"
    ],
    "old_name": "Untitled Corporation",
    "new_name": "Acme Corporation",
    "default_team": {
      "id": "BXeFatjDhdR",
      "display_name": "Acme Team"
    },
    "default_team_policy": "ADMIN_AND_UP"
  },
  "outcome": ...,
  "context": ...
}
JSON

Update a user in an organization

An actor triggers this event when they update a Canva user's membership within a Canva organization. This includes promoting a MEMBER to BRAND_DESIGNER or ADMIN, changing roles between BRAND_DESIGNER and ADMIN, or removing a user's ADMIN or BRAND_DESIGNER role.

typestring

Default value: UPDATE_USER_IN_ORGANIZATION

Available values: The only valid value is UPDATE_USER_IN_ORGANIZATION.

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.

old_rolestring
Optional

The user's role in the organization.

Available values:

  • ADMIN: Organization admin.
  • BRAND_DESIGNER: Organization brand designer.
  • MEMBER: Organization member.
new_rolestring
Optional

The user's role in the organization.

Available values:

  • ADMIN: Organization admin.
  • BRAND_DESIGNER: Organization brand designer.
  • MEMBER: Organization member.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_USER_IN_ORGANIZATION",
    "user": {
      "id": "UXoqDbwwSbQ",
      "display_name": "Jane Doe",
      "email": "[email protected]"
    },
    "old_role": "BRAND_DESIGNER",
    "new_role": "ADMIN"
  },
  "outcome": ...,
  "context": ...
}
JSON

Add a team to the organization

An actor triggers this event when they add a Canva Team to their Canva organization.

typestring

Default value: ADD_TEAM_TO_ORGANIZATION

Available values: The only valid value is ADD_TEAM_TO_ORGANIZATION.

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "ADD_TEAM_TO_ORGANIZATION",
    "team": {
      "id": "BXeFatjDhdR",
      "display_name": "Acme Team"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON

Remove a team from the organization

An actor triggers this event when they remove a Canva Team from their Canva organization.

typestring

Default value: REMOVE_TEAM_FROM_ORGANIZATION

Available values: The only valid value is REMOVE_TEAM_FROM_ORGANIZATION.

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.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "REMOVE_TEAM_FROM_ORGANIZATION",
    "team": {
      "id": "BXeFatjDhdR",
      "display_name": "Acme Team"
    }
  },
  "outcome": ...,
  "context": ...
}
JSON