Skip to main content
POST
/
tasks
Create task
curl --request POST \
  --url https://api.heffl.com/api/v2/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "showTime": true,
  "durationMinutes": 1,
  "assigneeIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "entityId": "<string>"
}
'
{
  "id": "<string>",
  "number": "<string>",
  "title": "<string>",
  "showTime": true,
  "assigneeIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "description": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "durationMinutes": 123,
  "completedOn": "2023-11-07T05:31:56Z",
  "entityId": "<string>",
  "projectId": "<string>",
  "leadId": "<string>",
  "dealId": "<string>",
  "clientId": "<string>",
  "contactId": "<string>",
  "createdById": "<string>",
  "createdByName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Body

application/json
​
title
string
required

Task title

​
description
string | null

Task description

​
status
enum<string>

Task status

Available options:
OPEN,
IN_PROGRESS,
ON_HOLD,
COMPLETED,
CANCELLED
​
type
enum<string>

Task type

Available options:
call,
todo,
meeting
​
priority
enum<string> | null

Task priority

Available options:
LOW,
MEDIUM,
HIGH
​
startDate
string<date-time>

Start date

​
dueDate
string<date-time>

Due date

​
showTime
boolean

Whether to show time on the due date

​
durationMinutes
number

Duration in minutes

Required range: x >= 0
​
assigneeIds
string[]

Assignee user IDs

​
tagIds
string[]

Tag IDs

​
entity
enum<string>

Entity type to link the task to

Available options:
projects,
leads,
deals
​
entityId
string | null

Entity ID to link the task to (required when entity is provided)

​
{key}
any

Custom field values using cf_* keys. Only documented fields and cf_* keys are accepted.

Response

OK

​
id
string
required

Task ID

​
number
string
required

Auto-generated task number

​
title
string
required

Task title

​
status
enum<string>
required

Task status

Available options:
OPEN,
IN_PROGRESS,
ON_HOLD,
COMPLETED,
CANCELLED
​
type
enum<string>
required

Task type

Available options:
call,
todo,
meeting
​
showTime
boolean
required

Whether to show time on the due date

​
assigneeIds
string[]
required

Assignee user IDs

​
tagIds
string[]
required

Tag IDs

​
description
string | null

Task description

​
priority
enum<string> | null

Task priority

Available options:
LOW,
MEDIUM,
HIGH
​
dueDate
string<date-time> | null

Due date

​
startDate
string<date-time> | null

Start date

​
durationMinutes
number | null

Duration in minutes

​
completedOn
string<date-time> | null

When the task was completed

​
entity
enum<string> | null

Linked entity type

Available options:
projects,
leads,
deals
​
entityId
string | null

Linked entity ID

​
projectId
string | null

Linked project ID

​
leadId
string | null

Linked lead ID

​
dealId
string | null

Linked deal ID

​
clientId
string | null

Linked client ID

​
contactId
string | null

Linked contact ID

​
createdById
string | null

Creator user ID

​
createdByName
string | null

Creator name

​
createdAt
string<date-time> | null

When the task was created

​
updatedAt
string<date-time> | null

When the task was last updated

​
{key}
any

Custom field values as top-level cf_* keys (for example cf_follow_up_type). There is no customFields wrapper.