Checkboxes through the REST-API

Question

Hi,

i try create some confluence pages through the REST-API. It's working with bold, sections etc very well, but checkboxes like this is a little trouble.

With the editor, its very easy using these brackets: []. But through the REST-API this is not possible, the will shown as plain text. Is there any solution for sending checkboxes through the API? i know its possible with the tasklist-macro, but if its possible i want to use the normal checkboxes.

David_Bakkers · Answer

Ignore my answer above. I just realised you are asking a question about a Confluence page, not a Jira issue. You can't alter a single checkbox on a Confluence page. You'd have to use the REST API to download the page content in HTML format, search for the checkbox you want to change, change its status from incomplete to complete, then upload the whole page of HTML back to Confluence to apply the change. Here's a sample of the HTML for a task list with two tasks, one complete (ticked), one incomplete (un-ticked):

1

complete

task is complete

2

incomplete

task is incomplete

David_Bakkers · Answer

A single checkbox will have only two values: on or off.

If you set the customfield's value to nothing (null) it will turn off.
If you set the customfield's value to Y, it will turn on, as in...

{ "fields" : { "customfield_12345" : { "value" :"Y" } } }