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 integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
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.
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
replyReply
A reply to a thread.
The author of the reply might be missing if that user account no longer exists.
idstring
The ID of the reply.
design_idstring
The ID of the design that the thread for this reply is attached to.
thread_idstring
The ID of the thread this reply is in.
contentCommentContent
The content of a comment thread or reply.
plaintextstring
The content in plaintext.
Any user mention tags are shown in the format [user_id:team_id].
markdownstring
Optional
The content in markdown.
Any user mention tags are shown in the format [user_id:team_id]
mentionsobject
The Canva users mentioned in the comment thread or reply.
<KEY>object of UserMentions
Information about the user mentioned in a comment thread or reply. Each user mention is keyed using the user's user ID and team ID separated by a colon (user_id:team_id).
The mention tag for the user mentioned in the comment thread or reply content. This has the format of the user's user ID and team ID separated by a colon (user_id:team_id).
userTeamUser
Metadata for the user, consisting of the User ID, Team ID, and display name.
user_idstring
Optional
The ID of the user.
team_idstring
Optional
The ID of the user's Canva Team.
display_namestring
Optional
The name of the user as shown in the Canva UI.
created_atinteger
When the reply was created, as a Unix timestamp
(in seconds since the Unix Epoch).
updated_atinteger
When the reply was last updated, as a Unix timestamp
(in seconds since the Unix Epoch).
authorUser
Optional
Metadata for the user, consisting of the User ID and display name.
idstring
The ID of the user.
display_namestring
Optional
The name of the user as shown in the Canva UI.
Example response
{
"reply":{
"id":"KeAZEAjijEb",
"design_id":"DAFVztcvd9z",
"thread_id":"KeAbiEAjZEj",
"author":{
"id":"uKakKUfI03Fg8k2gZ6OkT",
"display_name":"John Doe"
},
"content":{
"plaintext":"Great work [oUnPjZ2k2yuhftbWF7873o:oBpVhLW22VrqtwKgaayRbP]!",
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see Error responses.
messagestring
A human-readable description of what went wrong.
Example error responses
Message is too long
{
"code":"message_too_long",
"message":"Message is too long"
}
JSON
Mentions with non-obfuscated IDs are not allowed for this client
{
"code":"invalid_field",
"message":"Invalid IDs"
}
JSON
403 Forbidden
codestring
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see Error responses.
messagestring
A human-readable description of what went wrong.
Example error responses
This comment thread already has the maximum number of allowed replies
{
"code":"too_many_replies",
"message":"This comment thread already has the maximum number of allowed replies"
}
JSON
Not allowed to reply on this design
{
"code":"permission_denied",
"message":"Not allowed to reply on this design"
}
JSON
404 Not Found
codestring
A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see Error responses.