Create a Project To-do

curl --request POST \
  --url https://api.example.com/api/public/v1/project-todos/manage \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "idempotencyKey": "<string>",
  "jobId": "<string>",
  "audience": "<string>",
  "selectedContractIds": [
    "<string>"
  ],
  "preflightReceipt": "<string>",
  "version": {},
  "categoryId": "<string>",
  "key": "<string>",
  "autoAssignNewHires": true,
  "allowDuplicate": true
}
'

import requests

url = "https://api.example.com/api/public/v1/project-todos/manage"

payload = {
    "action": "<string>",
    "idempotencyKey": "<string>",
    "jobId": "<string>",
    "audience": "<string>",
    "selectedContractIds": ["<string>"],
    "preflightReceipt": "<string>",
    "version": {},
    "categoryId": "<string>",
    "key": "<string>",
    "autoAssignNewHires": True,
    "allowDuplicate": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    idempotencyKey: '<string>',
    jobId: '<string>',
    audience: '<string>',
    selectedContractIds: ['<string>'],
    preflightReceipt: '<string>',
    version: {},
    categoryId: '<string>',
    key: '<string>',
    autoAssignNewHires: true,
    allowDuplicate: true
  })
};

fetch('https://api.example.com/api/public/v1/project-todos/manage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/public/v1/project-todos/manage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => '<string>',
    'idempotencyKey' => '<string>',
    'jobId' => '<string>',
    'audience' => '<string>',
    'selectedContractIds' => [
        '<string>'
    ],
    'preflightReceipt' => '<string>',
    'version' => [
        
    ],
    'categoryId' => '<string>',
    'key' => '<string>',
    'autoAssignNewHires' => true,
    'allowDuplicate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/public/v1/project-todos/manage"

	payload := strings.NewReader("{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/public/v1/project-todos/manage")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/public/v1/project-todos/manage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}"

response = http.request(request)
puts response.read_body

POST

api

public

project-todos

manage

Create a Project To-do

curl --request POST \
  --url https://api.example.com/api/public/v1/project-todos/manage \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "idempotencyKey": "<string>",
  "jobId": "<string>",
  "audience": "<string>",
  "selectedContractIds": [
    "<string>"
  ],
  "preflightReceipt": "<string>",
  "version": {},
  "categoryId": "<string>",
  "key": "<string>",
  "autoAssignNewHires": true,
  "allowDuplicate": true
}
'

import requests

url = "https://api.example.com/api/public/v1/project-todos/manage"

payload = {
    "action": "<string>",
    "idempotencyKey": "<string>",
    "jobId": "<string>",
    "audience": "<string>",
    "selectedContractIds": ["<string>"],
    "preflightReceipt": "<string>",
    "version": {},
    "categoryId": "<string>",
    "key": "<string>",
    "autoAssignNewHires": True,
    "allowDuplicate": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    action: '<string>',
    idempotencyKey: '<string>',
    jobId: '<string>',
    audience: '<string>',
    selectedContractIds: ['<string>'],
    preflightReceipt: '<string>',
    version: {},
    categoryId: '<string>',
    key: '<string>',
    autoAssignNewHires: true,
    allowDuplicate: true
  })
};

fetch('https://api.example.com/api/public/v1/project-todos/manage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/public/v1/project-todos/manage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => '<string>',
    'idempotencyKey' => '<string>',
    'jobId' => '<string>',
    'audience' => '<string>',
    'selectedContractIds' => [
        '<string>'
    ],
    'preflightReceipt' => '<string>',
    'version' => [
        
    ],
    'categoryId' => '<string>',
    'key' => '<string>',
    'autoAssignNewHires' => true,
    'allowDuplicate' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/public/v1/project-todos/manage"

	payload := strings.NewReader("{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/public/v1/project-todos/manage")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/public/v1/project-todos/manage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"jobId\": \"<string>\",\n  \"audience\": \"<string>\",\n  \"selectedContractIds\": [\n    \"<string>\"\n  ],\n  \"preflightReceipt\": \"<string>\",\n  \"version\": {},\n  \"categoryId\": \"<string>\",\n  \"key\": \"<string>\",\n  \"autoAssignNewHires\": true,\n  \"allowDuplicate\": true\n}"

response = http.request(request)
puts response.read_body

Creates one to-do item, its first immutable version, and every initial assignment in a single transaction. Requires project_todos:write, a claimed account, and employer access to the job.

string

required

create_item

string

required

8–200 characters, bound to the complete request. Reuse the same key only to retry the identical request.

string

required

string

required

ACTIVE, FUTURE, ACTIVE_AND_FUTURE, or SELECTED. There is no default — omission fails with 400.

string[]

SELECTED only: a non-empty, duplicate-free list of active contracts on this exact job (up to 500). Invalid IDs reject the whole request with per-ID reasons.

string

Required for ACTIVE, FUTURE, and ACTIVE_AND_FUTURE. Mint it with preflight.

object

required

The worker-facing definition: title, type, optional description, content, ownerRole, required, priority (NORMAL | HIGH | URGENT), blockingMode (NONE | IMMEDIATE | AFTER_DUE), blockingScope, dueOffsetMinutes, reminderPolicy, and completionConfig.

string

Optional category; omitting uses the job’s General category.

string

Optional stable item key.

boolean

Adds future-hire auto-assignment to ACTIVE. Not allowed with SELECTED.

boolean

Overrides the 409 LIKELY_DUPLICATE refusal when an active item already carries this exact request.

Response

{
  "ok": true,
  "action": "create_item",
  "itemId": "…",
  "versionId": "…",
  "audience": "SELECTED",
  "includesFutureHires": false,
  "fanOut": { "matchedContracts": 1, "createdAssignments": 1, "assignmentIds": ["…"] },
  "recipients": [{ "contractId": "…", "workerUserId": "…", "displayName": "Alex B." }],
  "replayed": false,
  "warnings": []
}

recipients are the masked people this exact request was verified against. On an identical-request retry, replayed is true, createdAssignments is 0, and the roster is not re-resolved — a person hired after the original create is never silently added.

Failure modes

Beyond the common errors: the reserved time-tracking setup to-do cannot be authored here, and integration-type items require the matching configured provider on the job.

⌘I

Getting started

Connect your agent

Core concepts

Guides

API reference

CLI

MCP server

Annotation platforms

Create a Project To-do

Response

Failure modes

​Response

​Failure modes

Response

Failure modes