Skip to main content
POST
Create todo

Body

application/json
title
string
required

Short imperative of the durable need, such as 'Set up a user that can access admin'. Do not name the current flow, screen, or pull request, and do not include secrets.

Minimum string length: 1

Required. qa_tech_chat when QA.tech chat can finish it, code_agent when it needs a change in the customer's repository, manual only when neither can.

Available options:
manual,
qa_tech_chat,
code_agent
fixPrompt
string
required

Required. The next step, written as the message sent to QA.tech chat or copied to a code agent. Do not include secrets.

Minimum string length: 1
description
string | null

One to three sentences on the cause and the impact on testing. Do not include secrets.

kind
enum<string>

Category of follow-up work a todo represents.

Available options:
credentials,
integration,
test_user,
environment,
ownership,
device_preset,
start_url,
other
priority
enum<string>
Available options:
low,
medium,
high,
urgent
applicationShortId
string
Pattern: ^app(-.+_.+|_.+)$
configShortId
string
Pattern: ^cfg(-.+_.+|_.+)$

Project test case UUIDs blocked by this todo.

occurrenceReason
string

Why this need appeared now. Stored on the occurrence, not in the title.

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

todo
object
required