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
| Method | Path | Description |
|---|---|---|
GET | /api/v2/action-items?pageId={page_id}&blockId={block_id} | List action items in a block |
POST | /api/v2/action-items | Create action items |
PATCH | /api/v2/action-items/{action_item_id} | Update an action item |
DELETE | /api/v2/action-items/{action_item_id} | Delete an action item |
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
| Field | Type | Notes |
|---|---|---|
title | string | Required. |
description | string | |
status | enum | todo, in_progress, done, cancelled |
startDate | string | ISO 8601 |
dueDate | string | ISO 8601 |
internal | boolean | Hidden from buyers when true. Default false. |
assignees | string[] | Emails. Org members linked internally; others added as external contacts. |
List action items
GET /api/v2/action-items?pageId={page_id}&blockId={block_id}
Create action items
POST /api/v2/action-items
The page containing the action-plan block.
The action-plan block to add action items to.
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.
Updated title.
Updated description.
New status.
ISO 8601 start date.
ISO 8601 due date.
Whether the action item is hidden from buyers.
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}