Skip to main content

Create tasks from leads

Create workflow tasks from explicit lead IDs, a bulk selection, or a requested count. This is a mutating task-creation action; inspect the returned task IDs and counts before proceeding.

POST/api/task-queue/create-from-leads
HTTP referenceScope tasks:writeUpdated September 27, 2026

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 · optional

    string

    Optional active same-organization actor override.

Body parameters

  • selection · optional

    object

    BulkSelectionModel (mode ids or descriptor); use this or lead_ids/count.

  • lead_ids · optional

    array<string>

    Explicit CRM lead IDs.

  • count · optional

    integer

    Requested task count (1–5000).

  • processLimit · optional

    integer

    Maximum records to process (1–5000).

  • assignedToUserIds · optional

    array<string>

    Assignee user IDs.

  • assignmentPlan · optional

    array<object>

    Per-user assignments; each item requires userId and positive count.

  • channel · optional

    string

    call (default), email, phone, linkedin, or custom.

  • action · optional

    string

    call, personal_email, linkedin_visit_profile, linkedin_connect, linkedin_message, linkedin_voice_message, or custom.

  • priority · optional

    string

    low, medium (default), or high.

  • subject · optional

    string

    Task subject.

  • content · optional

    object

    Channel-specific task content.

  • notes · optional

    string

    Task notes.

  • instructions · optional

    string

    Instructions for the assignee.

  • schedule · optional

    object

    Schedule settings.

  • scheduling · optional

    object

    Simple scheduling settings.

  • researchContext · optional

    object

    Research table context; source_table_id is required when supplied.

  • taskGroupId · optional

    string

    Task group identifier.

  • dialerSessionId · optional

    string

    Dialer session identifier.

  • origin · optional

    string

    manual (default) or system.

  • senderBindings · optional

    object

    Sender selection bindings.

  • senderAccountId · optional

    string

    Sender account ID.

  • senderUserId · optional

    string

    Sender user ID.

  • email_type · optional

    string

    Email task type, personal or bulk.

  • email_provider · optional

    string

    Email provider identifier.

  • providerAccountEmail · optional

    string

    Provider account email.

  • campaignId · optional

    string

    Provider campaign ID.

  • campaignStep · optional

    integer

    Provider campaign step.

  • relatedActivityId · optional

    string

    Related CRM activity ID.

  • scope · optional

    string

    Legacy task scope selector.

  • sourceTableId · optional

    string

    Source table ID.

  • sourceTableScope · optional

    string

    Source table scope.

Definitions

SimpleTaskConfig

When scheduling.mode=simple, all three fields are required.

Fields

  • mode · optional

    string

  • startDaterequired

    string<date-time>

  • endDaterequired

    string<date-time>

  • daysBetweenCallsrequired

    integer

Errors

StatusMeaning
401Authentication is missing or invalid.
403Missing tasks:write.
422The selection, assignees, schedule, or requested task configuration is invalid.

Docs