Skip to main content
POST
Approve Tasks

Authorizations

X-API-Key
string
header
required

Body

application/json
taskIds
(string | null)[] | null

Selected task ids, 1 to 1000 unique nonblank values. Omit when allTasks=true. Other filters apply only to allTasks mode.

allTasks
boolean
default:false

Approve all matching todo tasks, up to limit per call. Must be explicitly true when taskIds are omitted.

limit
integer | null

Maximum tasks in allTasks mode. Defaults to 1000; must be between 1 and 1000. Omit with taskIds.

types
enum<string>[] | null

AllTasks mode: exact task kinds to include: call, manual, section_approval. Omit for all kinds.

Available options:
call,
manual,
section_approval
searchQuery
string | null

AllTasks mode: search prospect first name, last name, company name, and company domain.

assignedUserId
string | null

AllTasks mode: optional exact assigned user id. Defaults to the current user.

includeTeamTasks
boolean
default:false

AllTasks mode: include tasks owned by active members of the current team. Mutation permissions still apply.

flowIds
(string | null)[] | null

AllTasks mode: exact enrollment ids to filter tasks; do not pass flowPlanId.

ignoreTaskIds
(string | null)[] | null

AllTasks mode: task ids to exclude, for example previously failed tasks.

fromUtc
string<date-time> | null

AllTasks mode: created-from timestamp in UTC.

toUtc
string<date-time> | null

AllTasks mode: created-to timestamp in UTC.

email
string | null

AllTasks mode: prospect email filter.

firstName
string | null

AllTasks mode: prospect first name filter.

lastName
string | null

AllTasks mode: prospect last name filter.

companyDomain
string | null

AllTasks mode: company domain filter.

includeSuccessfulItems
boolean
default:false

Include successful tasks in items. Defaults to false; all failures and outcome counts are always returned.

Response

Tool result.