comment

Changed on
<Warning>

This API is currently provided as a preview. Be aware of the following:

  • There might be unannounced breaking changes.
  • Any breaking changes to preview APIs won't produce a new API version.
  • Public apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning>

Creates a reply to a comment or suggestion thread on a design. To reply to an existing thread, you must provide the ID of the thread which is returned when a thread is created, or from the thread_id value of an existing reply in the thread. Each thread can have a maximum of 100 replies created for it.

For information on comments and how they're used in the Canva UI, see the Canva Help Center.

post/v1/designs/{designId}/comments/{threadId}/replies

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/designs/{designId}/comments/{threadId}/replies
  • 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)

Path parameters

designIdstring required

The design ID.

threadIdstring required

The ID of the thread.

Request body

message_plaintextstring required

The comment message of the reply in plaintext. This is the reply comment 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].

Example request

{
  "message_plaintext": "Thanks!"
}

Response

OK

Example response

{
  "reply": {
    "id": "KeAZEAjijEb",
    "design_id": "DAFVztcvd9z",
    "thread_id": "KeAbiEAjZEj",
    "author": {
      "id": "uKakKUfI03Fg8k2gZ6OkT",
      "display_name": "John Doe"
    },
    "content": {
      "plaintext": "Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
      "markdown": "*_Great work_* [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!"
    },
    "mentions": {
      "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP": {
        "tag": "oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP",
        "user": {
          "user_id": "oUnPjZ2k2yuhftbWF7873o",
          "team_id": "oBpVhLW22VrqtwKgaayRbP",
          "display_name": "John Doe"
        }
      }
    },
    "created_at": 1692929800,
    "updated_at": 1692929900
  }
}

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