Create Task

Options

Body

Task name.

Request body which must comply to the following JSON Schema:

{
  "required" : [ "date", "name", "taskTypeId" ],
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string",
      "description" : "Name of task",
      "example" : "Task: Connect with client"
    },
    "duration" : {
      "minimum" : 0,
      "type" : "integer",
      "description" : "Duration of task in milliseconds [1 minute = 60000 ms]",
      "format" : "int64",
      "example" : 600000
    },
    "taskTypeId" : {
      "type" : "string",
      "description" : "Id for type of task e.g Call / Email / Meeting etc.",
      "example" : "61a5cd07ca1347c82306ad09"
    },
    "date" : {
      "type" : "string",
      "description" : "Task due date and time",
      "format" : "date-time",
      "example" : "2021-11-01T17:44:54.668Z"
    },
    "notes" : {
      "type" : "string",
      "description" : "Notes added to a task",
      "example" : "In communication with client for resolution of queries."
    },
    "done" : {
      "type" : "boolean",
      "description" : "Task marked as done",
      "example" : false
    },
    "assignToId" : {
      "type" : "string",
      "description" : "To assign a task to a user you can use either the account email or ID.",
      "example" : "5faab4b7f195bb3c4c31e62a"
    },
    "contactsIds" : {
      "type" : "array",
      "description" : "Contact ids for contacts linked to this task",
      "example" : [ 1, 2, 3 ],
      "items" : {
        "type" : "integer"
      }
    },
    "dealsIds" : {
      "type" : "array",
      "description" : "Deal ids for deals a task is linked to",
      "example" : [ "61a5ce58c5d4795761045990", "61a5ce58c5d4795761045991", "61a5ce58c5d4795761045992" ],
      "items" : {
        "type" : "string"
      }
    },
    "companiesIds" : {
      "type" : "array",
      "description" : "Companies ids for companies a task is linked to",
      "example" : [ "61a5ce58c5d4795761045990", "61a5ce58c5d4795761045991", "61a5ce58c5d4795761045992" ],
      "items" : {
        "type" : "string"
      }
    },
    "reminder" : {
      "required" : [ "types", "unit", "value" ],
      "type" : "object",
      "properties" : {
        "value" : {
          "type" : "integer",
          "description" : "Value of time unit before reminder is to be sent",
          "example" : 10
        },
        "unit" : {
          "type" : "string",
          "description" : "Unit of time before reminder is to be sent",
          "enum" : [ "minutes", "hours", "weeks", "days" ]
        },
        "types" : {
          "type" : "array",
          "description" : "Type of task reminder e.g email, push",
          "example" : [ "email" ],
          "items" : {
            "type" : "string",
            "enum" : [ "email", "push" ]
          }
        }
      },
      "description" : "Task reminder date/time for a task"
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers