comment

Changed on
<Warning>

This preview API is deprecated. You should use the Create thread API instead.

</Warning>

Create a new top-level comment on a design. For information on comments and how they're used in the Canva UI, see the Canva Help Center. A design can have a maximum of 1000 comments.

post/v1/comments

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/comments
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: comment:write)

Request body

messagestring required

The comment message. This is the comment body shown in the Canva UI.

You can also mention users in your message by specifying their User ID and Team ID using the format [user_id:team_id]. If the assignee_id parameter is specified, you must mention the assignee in the message.

assignee_idstring

Lets you assign the comment to a Canva user using their User ID. You must mention the assigned user in the message.

Example request

{
  "attached_to": {
    "design_id": "DAFVztcvd9z",
    "type": "design"
  },
  "message": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
  "assignee_id": "oUnPjZ2k2yuhftbWF7873o"
}

Response

OK

Example response

{
  "comment": {
    "id": "KeAbiEAjZEj",
    "attached_to": {
      "design_id": "DAFVztcvd9z",
      "type": "design"
    },
    "message": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
    "author": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "created_at": 1692928800,
    "updated_at": 1692928900,
    "mentions": {
      "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
        "user_id": "oUnPjZ2k2yuhftbWF7873o",
        "team_id": "oBpVhLW22VrqtwKgaayRbP",
        "display_name": "John Doe"
      }
    },
    "assignee": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "resolver": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    }
  }
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status