Skip to main content
Terminology: the action-plan block is the container (created via POST /api/v2/blocks with type: "action-plan"). The individual tasks inside it are called action items and are managed via the endpoints on this page.

Endpoints

Both pageId and blockId are mandatory for listing and creating. The blockId must point to an existing action-plan block. See Blocks to create one.

Action item fields


List action items

GET /api/v2/action-items?pageId={page_id}&blockId={block_id}

Create action items

POST /api/v2/action-items
pageId
string
required
The page containing the action-plan block.
blockId
string
required
The action-plan block to add action items to.
items
array
required
Array of action item objects.
Example

Update an action item

PATCH /api/v2/action-items/{action_item_id} All fields are optional. assignees replaces the full assignee list.
title
string
Updated title.
description
string
Updated description.
status
"todo" | "in_progress" | "done" | "cancelled"
New status.
startDate
string
ISO 8601 start date.
dueDate
string
ISO 8601 due date.
internal
boolean
Whether the action item is hidden from buyers.
assignees
string[]
Replaces the full assignee list. Pass an empty array to remove all assignees.
Example

Delete an action item

DELETE /api/v2/action-items/{action_item_id}