Canva · Schema

Comment

A comment on a design

AppsAutomationBrand ManagementCollaborationDesignGraphicsMarketingPrintTemplatesVisual Content

Properties

Name Type Description
type string The comment type
id string The comment ID
message string The comment text. User mentions use the format [user_id:team_id].
created_at integer Unix timestamp in seconds when the comment was created
updated_at integer Unix timestamp in seconds when the comment was last updated
mentions object Dictionary of mentioned users, keyed by their mention identifier
View JSON Schema on GitHub

JSON Schema

canva-connect-comment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Comment",
  "type": "object",
  "description": "A comment on a design",
  "properties": {
    "type": {
      "type": "string",
      "description": "The comment type"
    },
    "id": {
      "type": "string",
      "description": "The comment ID"
    },
    "message": {
      "type": "string",
      "description": "The comment text. User mentions use the format [user_id:team_id]."
    },
    "created_at": {
      "type": "integer",
      "description": "Unix timestamp in seconds when the comment was created"
    },
    "updated_at": {
      "type": "integer",
      "description": "Unix timestamp in seconds when the comment was last updated"
    },
    "mentions": {
      "type": "object",
      "description": "Dictionary of mentioned users, keyed by their mention identifier"
    }
  }
}