Skip to main content
POST
/
tasks
Create a new task
curl --request POST \
  --url https://api.heffl.com/api/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "type": "todo",
  "status": "OPEN",
  "dueDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "entityId": "<string>"
}
'
{
  "id": "<string>",
  "number": "<string>",
  "title": "<string>",
  "status": "<string>",
  "type": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "priority": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "startDate": "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

Minimum string length: 1
​
description
string

Task description

​
type
enum<string>
default:todo

Task type

Available options:
call,
todo,
meeting
​
status
enum<string>
default:OPEN

Task status

Available options:
OPEN,
IN_PROGRESS,
ON_HOLD,
COMPLETED,
CANCELLED
​
dueDate
string<date-time>

Due date for the task

​
startDate
string<date-time>

Start date for the task

​
priority
enum<string>

Task priority

Available options:
LOW,
MEDIUM,
HIGH
​
entity
enum<string>

Entity type to associate the task with

Available options:
leads,
deals,
clients
​
entityId
string

Public ID of the entity to associate the task with

​
{key}
any

Response

200 - application/json

OK

​
id
string
required

Task public ID

​
number
string
required

Auto-generated task number

​
title
string
required

Task title

​
status
string
required

Task status

​
type
string
required

Task type

​
createdAt
string<date-time>
required

When the task was created

​
description
string | null

Task description

​
priority
string | null

Task priority

​
dueDate
string<date-time> | null

Due date

​
startDate
string<date-time> | null

Start date