Tasks

Create a new task

Creates a new task. The task will be assigned to the user associated with your API key.

post/tasks

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/tasks
  • Auth: API key in header x-api-key

Request body

titlestring required

Task title

descriptionstring

Task description

type'call' | 'todo' | 'meeting'

Task type

status'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED'

Task status

dueDatestring date-time

Due date for the task

startDatestring date-time

Start date for the task

priority'LOW' | 'MEDIUM' | 'HIGH'

Task priority

entity'leads' | 'deals' | 'clients'

Entity type to associate the task with

entityIdstring

Public ID of the entity to associate the task with

Response

OK

idstring required

Task public ID

numberstring required

Auto-generated task number

titlestring required

Task title

descriptionstring nullable

Task description

statusstring required

Task status

typestring required

Task type

prioritystring nullable

Task priority

dueDatestring date-time nullable

Due date

startDatestring date-time nullable

Start date

createdAtstring date-time required

When the task was created

Changes

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