Skip to Content

Tasks

ToolWhat it does
task_archiveArchive a pending task irreversibly after approval; a live sequence task releases its contact.
task_bulk_updateApply one approved action to selected tasks, reporting updated, skipped and failed counts.
task_completeComplete one task, supplying an outcome when it is a phone-call task.
task_createCreate an ad-hoc task against an existing person, account or deal.
task_getGet full detail for one task by its id: task name, task type, status, priority, due date, assignees, the linked contact/account/deal record and company, the sequence the task belongs to, notes, and (for a completed or archived task) who closed the task and why.
task_reassignAdd or remove task assignees, or clear the assignment explicitly.
task_searchSearch or list the team’s tasks by quick tab, assignee, task status, due date range, priority, task type, sequence, or linked contact/account/deal, with free text and pagination; also returns quick-tab counts, the due/overdue task badge, and facet counts.
task_updateUpdate one pending task’s due date, priority, name, notes or social text.

task_archive

Archive a pending task irreversibly after approval; a live sequence task releases its contact.

Archive a task the user explicitly names, closing it out without marking it done. Never suggest archiving proactively — always confirm first.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-archive
MCP tooltask_archive on https://mcp.prospeo.io
EffectDeletes or removes data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_bulk_update

Apply one approved action to selected tasks, reporting updated, skipped and failed counts.

Bulk-apply one action — complete, archive, set due date, set priority, or reassign — to a set of tasks by oid in a single call (20,000-task cap).

EndpointPOST https://api.prospeo.io/api/v2/tools/task-bulk-update
MCP tooltask_bulk_update on https://mcp.prospeo.io
EffectDeletes or removes data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidsarray of stringYesUp to 20000 items.
actionstring (enum)YesOne of: COMPLETE, ARCHIVE, SET_DUE, SET_PRIORITY, REASSIGN.
due_atstringNo
due_timezonestringNoLength 0 to 64.
prioritystringNo
add_assignee_oidsarray of stringNo
remove_assignee_oidsarray of stringNo
clear_assigneesbooleanNoDefault false.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_complete

Complete one task, supplying an outcome when it is a phone-call task.

Mark a task done. For a sequence-linked task this advances the contact to the sequence’s next step; a phone-call task requires a logged call outcome before it can complete. The outcome Asked not to be called is accepted here only when the task’s call already has it logged, because it marks the contact Do Not Contact for the whole team: log it with call_log first, which asks for approval, then complete the task.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-complete
MCP tooltask_complete on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
call_logobjectNo

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_create

Create an ad-hoc task against an existing person, account or deal.

Create an ad-hoc task (manual email, phone call, social action, or custom action) against one person, account, or deal, with a due date, priority, and assignees.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-create
MCP tooltask_create on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_typestring (enum)YesTask channel — the manual step types (Automatic email is never a task). One of: MANUAL_EMAIL, PHONE_CALL, SOCIAL_SEND_CONNECT_REQUEST, SOCIAL_SEND_MESSAGE, SOCIAL_VIEW_PROFILE, SOCIAL_INTERACT_WITH_POST, CUSTOM_ACTION.
record_typestring (enum)NoWhat a task is attached to. Sequence tasks are always PERSON. One of: PERSON, ACCOUNT, DEAL. Default "PERSON".
sequence_oidstringNoPattern ^[0-9a-fA-F]{24}$.
deal_oidstringNoPattern ^[0-9a-fA-F]{24}$.
saved_person_oidstringNoPattern ^[0-9a-fA-F]{24}$.
saved_company_oidstringNoPattern ^[0-9a-fA-F]{24}$.
namestringNo
notesstringNoDefault "".
due_atstringYes
due_timezonestringNoLength 0 to 64.
prioritystringNoDefault "MEDIUM".
assignee_oidsarray of stringNo
social_messagestringNo
connection_notestringNo
action_namestringNo

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_get

Get full detail for one task by its id: task name, task type, status, priority, due date, assignees, the linked contact/account/deal record and company, the sequence the task belongs to, notes, and (for a completed or archived task) who closed the task and why.

Fetch full detail for one task by its oid — status, due date, priority, assignees, linked record, notes, and (for a closed task) who closed it and why.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-get
MCP tooltask_get on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidstringYesThe task’s public id. Length 1 to 128.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_reassign

Add or remove task assignees, or clear the assignment explicitly.

Add and/or remove assignees on one task by delta (additions/removals apply on top of the current assignee set — any current assignee not named in remove_assignee_oids stays), or clear all assignees at once.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-reassign
MCP tooltask_reassign on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
add_assignee_oidsarray of stringNo
remove_assignee_oidsarray of stringNo
clear_allbooleanNoDefault false.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Search or list the team’s tasks by quick tab, assignee, task status, due date range, priority, task type, sequence, or linked contact/account/deal, with free text and pagination; also returns quick-tab counts, the due/overdue task badge, and facet counts.

Search the team’s tasks by status, assignee, due-date range, priority, task type, or linked person/account/deal, with free text and pagination; also returns quick-tab counts, the nav badge count, and facet counts.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-search
MCP tooltask_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
pageintegerNo1-based page number; fixed at 25 rows per page. From 1 to any. Default 1.
quick_tabstring (enum)NoGlobal Tasks page quick tab. One of: ALL, EMAILS, CALLS, SOCIALS, CUSTOMS, OVERDUE. Default "ALL".
assignee_oidstringNoOne specific teammate. 400s if it cannot be resolved to a team member.
unassigned_onlybooleanNoThe ‘Nobody’ assignee facet. Default false.
all_assigneesbooleanNoThe ‘Anybody’ facet — bypasses the caller-only default. Default false.
statusesarray of string (enum)NoUp to 4 items. Items one of: PENDING, COMPLETED, ARCHIVED, AUTO_SKIPPED.
searchstringNoFree-text match on task name or the linked contact/company name. Length 0 to 500.
sequence_oidstringNoScope to one sequence’s Tasks tab.
task_typesarray of string (enum)NoUp to 7 items. Items one of: MANUAL_EMAIL, PHONE_CALL, SOCIAL_SEND_CONNECT_REQUEST, SOCIAL_SEND_MESSAGE, SOCIAL_VIEW_PROFILE, SOCIAL_INTERACT_WITH_POST, CUSTOM_ACTION.
record_typestring (enum)NoNested ‘Record type’ facet under Task type. One of: PERSON, ACCOUNT, DEAL.
sequence_oidsarray of stringNoSequence facet (multi). Up to 200 items.
prioritiesarray of string (enum)NoItems one of: LOW, MEDIUM, HIGH.
due_bucketstring (enum)NoIndependent of due_from/due_to. One of: OVERDUE, DUE_TODAY, ALL_UPCOMING.
due_fromstringNo
due_tostringNo
completed_fromstringNo
completed_tostringNo
created_fromstringNo
created_tostringNo
stage_idsarray of integerNoContact/Account CRM-shell stage ids (small team-scoped config ints, not record ids). Up to 200 items.
stage_ids_excludearray of integerNoUp to 200 items.
company_oidsarray of stringNoUp to 200 items.
person_oidsarray of stringNoUp to 200 items.
job_titlesarray of stringNoUp to 50 items.
deal_oidsarray of stringNoThe deal record page’s own ‘Tasks (N open)’ scope. Up to 200 items.
step_indexesarray of integerNo§8.13 per-sequence Tasks tab ‘Step’ facet. Up to 50 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

task_update

Update one pending task’s due date, priority, name, notes or social text.

Edit an open task’s due date, priority, notes, name, or (for social tasks) its drafted message/connection note. Changing the due date also shifts the task’s auto-skip window on a sequence-linked task.

EndpointPOST https://api.prospeo.io/api/v2/tools/task-update
MCP tooltask_update on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
task_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
due_atstringNo
due_timezonestringNoLength 0 to 64.
prioritystringNo
notesstringNo
namestringNo
social_messagestringNo
connection_notestringNo

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Last updated on