[API] HTML and/or markup in task content
completed
Jay Stephenson
Allow for HTML and/or markup to be used in the content of a create task call. That way extra design can be added to the task content vs straight text.
Log In
Silver Fox
Is there a possibility to get markup content? Like i want to update task and want to save headers, etc. So, at first, i get a task, and there is only text (no markup). And another question, could we use the same when we create comments?
Zeb
marked this post as
completed
This is now available!
Carson Wilson
Zeb: Is this in fact now available? If so how can I create a task via the API in which my markdown is enabled? Currently, as Daniel Krüger reports below, any markdown I pass to ClickUp via the following API call is simply included as text in my task description:
curl --include --request POST --header "Authorization: "(my personal token)"" --header "Content-Type: application/json" -d @- 'https://api.clickup.com/api/v2/list/(my task id)/task'
I would appreciate any help with this, even if it is simply to confirm that this capability is not available.
Zeb
Carson Wilson: Hi Carson! We do allow you to set rich text formatting when creating tasks via the public API via markdown. To achieve this, use the
markdown_description
property with valid mark down syntax in the create task route. The markdown features that are supported are the following: headers, lists, emphasis, bold, block quotes, inline code, code blocks, links, and images.Here is an example:
POST /api/v2/list/:list_id/task
{
“name”: “task name”,
“markdown_description”: “#heading”
}
I hope this helps!
Carson Wilson
Thank you, Zeb, this does help immensely!
I would note however that AFAIK
this thread is currently the only public documentation of this feature.
The ClickUp 2.0 API document I am going by states,Instead of content you can pass markdown_content with valid markdown syntax to add formatting to the task description.
However,
markdown_content
does not currently seem to work whereas markdown_description
does.Zeb
Carson Wilson: Ah got it we'll get it updated, thank you!
R
Ramit Srivastava
Zeb Carson Wilson: Is this supported in get call? I do not see the markdown formatted description in the task GET call
Zeb
Ramit Srivastava: Not supported yet, we're getting it done with our next version of API (in progress now)
Zeb
marked this post as
building now
Daniel Krüger
Hey Zeb,
I was hoping that this exactly was the point when anouncing the improvement from the latest updates saying:
Create Tasks With Markdown via API & Zapier
Seems like I misunderstood, since I just tried to create a task via the API with some Markdown content but failed.
Could you kindly clear that point for us?
Best regards
Daniel
J
Jared Van Kirk
Daniel Krüger: Agreed. There does not seem to be any documentation for how to use the API to create tasks with markdown. I've tried posting using content parameter and it just posts the raw markdown to the task. I have noticed that you can pass a Quill Delta object via content parameter and get some great results, but this is not documented behavior. If ClickUp could provide an "official" response to using the API to post markdown or delta, that would be very helpful.
Daniel Krüger
Jared Van Kirk: Quill Delta object? Sounds very interesting. I shall give that approach a try asap :)
Thanks for that piece of advice.