Skip to main content

Create tasks

Create workflow tasks for one or more leads/assignees.

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

This page documents the canonical HTTP contract for this endpoint.

TaskQueueCreate does not accept a top-level linkedin_action. It stores the optional content object as supplied and does not validate a channel-specific content schema at creation; execution routes apply their own checks. Unknown top-level fields are ignored.

Creation is a database task-creation operation; it does not itself send the email or LinkedIn message.

Content payload by channel

ChannelExample content object
email{ "type": "email", "subject": "…", "body": "…" }
call / phone{ "type": "call", "script": "…" }
linkedin{ "type": "linkedin_connect", "message": "…" }
linkedin{ "type": "linkedin_message", "body": "…" }
linkedin{ "type": "linkedin_voice_message", "message": "…", "voice_message": { "blob_name": "…" } }
linkedin{ "type": "linkedin_visit_profile", "notify": true }
custom{ "type": "custom", "description": "…" }

These are illustrative content objects, not validated alternatives in the create request schema. This endpoint creates review tasks only; it does not select or execute a LinkedIn action.

Query parameters

  • actorUserId · optional

    string

    Optional actor override; affects mutation actor identity.

Body parameters

  • lead_idsrequired

    array<string>

    Lead IDs to create tasks for.

  • assigned_to_idsrequired

    array<string>

    One or more assignee user IDs; at least one is required.

  • channel · optional

    string

    email, phone, linkedin, call, or custom; defaults to call.

  • priority · optional

    string

    low, medium, or high; defaults to medium.

  • schedulingrequired

    object

    SimpleTaskConfig: mode="simple", daysBetweenCalls (1–30), startDate, and endDate.

  • task_group_id · optional

    string

    Optional task group ID.

  • subject · optional

    string

    Optional task subject.

  • content · optional

    object

    Optional typed task content; shape depends on channel.

  • notes · optional

    string

    Optional task notes.

  • instructions · optional

    string

    Optional task instructions.

  • research_context · optional

    object

    Optional ResearchContext.

  • communication_context · optional

    object

    Optional Inbox conversation/message context.

  • dialer_session_id · optional

    string

    Optional parallel dialer session ID.

  • origin · optional

    string

    sequence, manual, or system; defaults to manual.

  • sender_bindings · optional

    object

    Optional channel-keyed sender bindings.

  • sender_account_id · optional

    string

    Optional sender account ID.

  • sender_user_id · optional

    string

    Optional sender owner user ID.

  • senderBindings · optional

    object

    Camel-case alias for sender_bindings.

  • senderAccountId · optional

    string

    Camel-case alias for sender_account_id.

  • senderUserId · optional

    string

    Camel-case alias for sender_user_id.

  • email_type · optional

    string

    personal or bulk.

  • email_provider · optional

    string

    gmail, microsoft, instantly, smartlead, or internal.

  • provider_account_email · optional

    string

    Optional email sender mailbox.

  • campaign_id · optional

    string

    Optional provider campaign ID.

  • campaign_step · optional

    integer

    Optional provider campaign step.

  • related_activity_id · optional

    string

    Optional related activity ID.

  • sequence_execution_mode · optional

    string

    Optional sequence execution mode.

  • sequence_blocks · optional

    boolean

    Optional sequence blocking flag.

Definitions

LinkedIn task request

An alternate complete request body. Send one request object per call.

LinkedIn task request example

json
{
  "lead_ids": [
    "67c4b113b4dd8f2d4999f0f1"
  ],
  "assigned_to_ids": [
    "67c1dc35b4dd8f2d4999ed01"
  ],
  "channel": "linkedin",
  "content": {
    "type": "linkedin_message",
    "body": "Hi {{first_name}}, saw your work at {{company_name}}."
  },
  "scheduling": {
    "mode": "simple",
    "startDate": "2030-03-03T16:00:00Z",
    "endDate": "2030-03-03T16:00:00Z",
    "daysBetweenCalls": 1
  }
}

Errors

StatusMeaning
400Invalid payload or actor.
401Invalid API key or missing auth.
403Missing tasks:write scope.

Docs