This page documents the canonical HTTP contract for this endpoint.
Assignee IDs come from List organization users. For selected rows, see the workspace selection catalog. Creation may skip leads that cannot be processed; inspect the returned counts and IDs. No email or LinkedIn message is sent by task creation alone.
Query parameters
actorUserId· optionalstring
Optional active same-organization actor override.
| Name | Type | Description |
|---|---|---|
| actorUserId | string | Optional active same-organization actor override. |
Body parameters
selection· optionalobject
BulkSelectionModel (mode ids or descriptor); use this or lead_ids/count.
lead_ids· optionalarray<string>
Explicit CRM lead IDs.
count· optionalinteger
Requested task count (1–5000).
processLimit· optionalinteger
Maximum records to process (1–5000).
assignedToUserIds· optionalarray<string>
Assignee user IDs.
assignmentPlan· optionalarray<object>
Per-user assignments; each item requires userId and positive count.
channel· optionalstring
call (default), email, phone, linkedin, or custom.
action· optionalstring
call, personal_email, linkedin_visit_profile, linkedin_connect, linkedin_message, linkedin_voice_message, or custom.
priority· optionalstring
low, medium (default), or high.
subject· optionalstring
Task subject.
content· optionalobject
Channel-specific task content.
notes· optionalstring
Task notes.
instructions· optionalstring
Instructions for the assignee.
schedule· optionalobject
Schedule settings.
scheduling· optionalobject
Simple scheduling settings.
researchContext· optionalobject
Research table context; source_table_id is required when supplied.
taskGroupId· optionalstring
Task group identifier.
dialerSessionId· optionalstring
Dialer session identifier.
origin· optionalstring
manual (default) or system.
senderBindings· optionalobject
Sender selection bindings.
senderAccountId· optionalstring
Sender account ID.
senderUserId· optionalstring
Sender user ID.
email_type· optionalstring
Email task type, personal or bulk.
email_provider· optionalstring
Email provider identifier.
providerAccountEmail· optionalstring
Provider account email.
campaignId· optionalstring
Provider campaign ID.
campaignStep· optionalinteger
Provider campaign step.
relatedActivityId· optionalstring
Related CRM activity ID.
scope· optionalstring
Legacy task scope selector.
sourceTableId· optionalstring
Source table ID.
sourceTableScope· optionalstring
Source table scope.
| Name | Type | Description |
|---|---|---|
| selection | object | BulkSelectionModel (mode ids or descriptor); use this or lead_ids/count. |
| lead_ids | array<string> | Explicit CRM lead IDs. |
| count | integer | Requested task count (1–5000). |
| processLimit | integer | Maximum records to process (1–5000). |
| assignedToUserIds | array<string> | Assignee user IDs. |
| assignmentPlan | array<object> | Per-user assignments; each item requires userId and positive count. |
| channel | string | call (default), email, phone, linkedin, or custom. |
| action | string | call, personal_email, linkedin_visit_profile, linkedin_connect, linkedin_message, linkedin_voice_message, or custom. |
| priority | string | low, medium (default), or high. |
| subject | string | Task subject. |
| content | object | Channel-specific task content. |
| notes | string | Task notes. |
| instructions | string | Instructions for the assignee. |
| schedule | object | Schedule settings. |
| scheduling | object | Simple scheduling settings. |
| researchContext | object | Research table context; source_table_id is required when supplied. |
| taskGroupId | string | Task group identifier. |
| dialerSessionId | string | Dialer session identifier. |
| origin | string | manual (default) or system. |
| senderBindings | object | Sender selection bindings. |
| senderAccountId | string | Sender account ID. |
| senderUserId | string | Sender user ID. |
| email_type | string | Email task type, personal or bulk. |
| email_provider | string | Email provider identifier. |
| providerAccountEmail | string | Provider account email. |
| campaignId | string | Provider campaign ID. |
| campaignStep | integer | Provider campaign step. |
| relatedActivityId | string | Related CRM activity ID. |
| scope | string | Legacy task scope selector. |
| sourceTableId | string | Source table ID. |
| sourceTableScope | string | Source table scope. |
Definitions
SimpleTaskConfig
When scheduling.mode=simple, all three fields are required.
Fields
mode· optionalstring
startDaterequiredstring<date-time>
endDaterequiredstring<date-time>
daysBetweenCallsrequiredinteger
| Name | Type | Description |
|---|---|---|
| mode | string | - |
| startDaterequired | string<date-time> | - |
| endDaterequired | string<date-time> | - |
| daysBetweenCallsrequired | integer | - |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is missing or invalid. |
| 403 | Missing tasks:write. |
| 422 | The selection, assignees, schedule, or requested task configuration is invalid. |
