Trying to add a checkbox item in description via the API

Sofiane Az_
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
January 14, 2025

 

 

$description = array(
        "type" => "doc",
        "version" => 1,
        "content" => array(
            array(
                "type" => "paragraph",
                "content" => array(
                    array(
                        "type" => "text",
                        "text" => "hello \n - {todo} {task} {} [open] to do"
                    ),
                )
            )
        )
    );
    $dataUser = array(
        "fields" => array(
            "description" => $description  
        )
    );

Every kind of markdown isnot interpreted by the description field, the one I am tring to add is the task item which makes a checkbox. 

2 answers

0 votes
Angela Thomas_Seibert Group
Atlassian Partner
January 14, 2025

Currently, this feature is not supported, as Jira Action items were rolled out only recently. If you review the comments on the original post, you'll notice that other Jira users like yourself have highlighted similar limitations.

To address these gaps, we've compiled a guide that compares these limitations with the features offered by a comprehensive checklist plug-in like Didit. You can find the detailed comparison here.

0 votes
Darryl Lee
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
January 14, 2025

Hi - it looks like you're talking about the new Action Items in Jira.

You are correct that markdown is not supported for adding checkboxes ("action items") via the API, Automation, etc.

I haven't tried using the API to add tasks, but looking at the API v3 Get issue endpoint you can see how Action Items (checklist) data is stored in the Description field, with a new content type, taskList that contains and array of taskItems. Example here.

@David Bakkers found that you don't need to specify a valid localId parameter, so you should be able to start with his example here.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
TAGS
AUG Leaders

Atlassian Community Events