Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Tasks

Create a task

post/crm/tasks

Request body

namestring required

Name of task

durationinteger

Duration of task in milliseconds [1 minute = 60000 ms]

taskTypeIdstring required

Id for type of task e.g Call / Email / Meeting etc.

datestring date-time required

Task due date and time

notesstring

Notes added to a task

doneboolean

Task marked as done

assignToIdstring

To assign a task to a user you can use either the account email or ID.

contactsIdsinteger[]

Contact ids for contacts linked to this task

dealsIdsstring[]

Deal ids for deals a task is linked to

companiesIdsstring[]

Companies ids for companies a task is linked to

Example request

{
  "name": "Task: Connect with client",
  "duration": 600000,
  "taskTypeId": "61a5cd07ca1347c82306ad09",
  "date": "2021-11-01T17:44:54.668Z",
  "notes": "In communication with client for resolution of queries.",
  "assignToId": "5faab4b7f195bb3c4c31e62a",
  "contactsIds": [
    1,
    2,
    3
  ],
  "dealsIds": [
    "61a5ce58c5d4795761045990",
    "61a5ce58c5d4795761045991",
    "61a5ce58c5d4795761045992"
  ],
  "companiesIds": [
    "61a5ce58c5d4795761045990",
    "61a5ce58c5d4795761045991",
    "61a5ce58c5d4795761045992"
  ],
  "reminder": {
    "value": 10,
    "types": [
      "email"
    ]
  }
}

Response

Created new task

idstring required

Unique task id

Example response

{
  "id": "61a5cd07ca1347c82306ad06"
}