Sign in
tasks

Create a task

Creates a task and assigns it to one or more prospects. Supported task types are Email (1), LinkedIn (2), and General (13). To create a task for a single prospect, provide <code>prospectId</code>. To create the same task for multiple prospects at once, provide <code>prospectIds</code> as an array — the response will include a results array with the outcome per prospect, so a failure for one does not affect the others.

post/v1/tasks/create

Request body

prospectIdsstring[] required

List of prospect IDs to create the task for. Pass a single-element array for one prospect, or multiple IDs to create the same task for several prospects in one request.

taskType'2' | '3' | '4' | '5' | '6' | '9' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' required

The type of task. Accepted values: "2" = LinkedIn connection request, "3" = LinkedIn message, "4" = LinkedIn InMail, "5" = LinkedIn view profile, "6" = LinkedIn post interaction, "9" = Custom, "11" = Call introduction, "12" = Call demo, "13" = Call follow-up, "14" = Call reminder, "15" = Call other, "16" = WhatsApp message, "17" = WhatsApp voice message, "18" = WhatsApp voice call.

priority'1' | '2' | '3' | '4'

The priority level of the task. Accepted values: "1" = Urgent, "2" = High, "3" = Medium, "4" = Low. Defaults to no priority if not provided.

dueDatestring

The due date for the task in YYYY-MM-DD format (e.g. "2026-04-22"). Defaults to today if not provided.

taskNotestring

An optional note or description to attach to the task.

Example request

{
  "prospectIds": [
    "8PvBmrB7P7"
  ],
  "taskType": "13",
  "priority": "3",
  "dueDate": "2026-04-22",
  "taskNote": "Call to follow up on the proposal sent yesterday."
}

Response

Task created successfully

{"stackTrail":"paths:/v1/tasks/create:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Task created successfully","payload":{"results":[{"prospectId":"Pr9xQ2Lm","taskId":"7PWYDWW7zo","success":true},{"prospectId":"Pr4Kb8Qw","taskId":"Mw5Mjoo1wb","success":true},{"prospectId":"INVALIDxx","taskId":null,"success":false}]}}}

Example response

{
  "message": "Task created successfully",
  "payload": {
    "results": [
      {
        "prospectId": "Pr9xQ2Lm",
        "taskId": "7PWYDWW7zo",
        "success": true
      },
      {
        "prospectId": "Pr4Kb8Qw",
        "taskId": "Mw5Mjoo1wb",
        "success": true
      },
      {
        "prospectId": "INVALIDxx",
        "taskId": null,
        "success": false
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.