Markdown or other formatting options for comments added through API
complete
E
Em Goss
From support ticket: I'd like to have formatting options when it comes to posting a comment through the API. Markdown, HTML, etc.
Log In
Brendan W
complete
We've updated our API Docs to include examples on using comment formatting! Check it out:
Jake Spirek
Brendan W: did you mean this link? https://jsapi.apiary.io/apis/clickup20/reference/0/comments/get-list.html
B
Branimir
Brendan W: can you please provide what has been chnaged? I look at documentation 2 days ago and it seems same to me. Did you add markdown and html option in coments through api?
Micah Mitchell
Brendan W: So we have to know which specific parts of the comment are supposed to be bolded/italicized/lists/etc and then reformat each specially formatted chunk into a json? The amount of work needed to do that isn't worth it. Is there no way to pass a "markdown" or "html" type? I feel that the request for formatting options meant "html" or "markup" - not "you parse it on your own then restructure each section into specifically structured jsons...".
Kristian ILiev
Em Goss
Interestingly, a lot of this is already possible (not sure about HTML). It is simply not documented in the API. The best way to see what you can do, is to perform GET requests with the API on existing comments that contain formatting, markdown, emojis, etc etc.
Your GET request (in "comment" json field) contains the same format you can use with a POST request (Note: either "comment" as an array OR "comment_text" as string, if you use both, you get a duplicate comment).
I am unsure of the limitations, I know emojis, bold/italic/underline, @ mentions - only user ID is required - are all possible with POST (using the format of the GET requests as examples). Other than that, I presume a lot more is possible, but have not tested.
Albeit it is painful to insert emojis (must use an emoji code that we don't have a list of). But everything else (I know of so far) doesn't appear difficult to use.
Micah Mitchell
Yes please this!