Skip to main content
POST
/
api
/
tasks
Create a task
curl --request POST \
  --url https://core-api.getaptly.com/api/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "title": "Call the tenant",
  "assigneeId": "usr_123",
  "dueAt": "2026-06-10T00:00:00.000Z",
  "type": "task",
  "priority": "high",
  "status": "notStarted"
}
'
{
  "taskId": "<string>"
}

Authorizations

​
x-token
string
header
required

Body

application/json
​
title
string
required
​
assigneeId
string
required

User id the task is assigned to.

​
dueAt
string<date-time>
required
​
type
string
required

Follow-up type — one of email|comment|sms|voice|card|note|task|logActivity.

​
userId
string

Acting user the task is attributed to (createdBy/updatedBy). Required with API-key auth (must belong to the company); ignored with a delegate token, which supplies the user itself.

​
note
string

Task description.

​
status
string

One of backlog|notStarted|inProgress|onHold|completed.

​
priority
string

One of asap|high|medium|low.

​
logType
string

Required when type is "logActivity".

​
aptletInstanceId
string

Card id — when set the task is mirrored onto the card checklist.

​
aptletUuid
string
​
channelId
string
​
streamId
string
​
fieldId
string

Checklist array field on the card (defaults to "checklist").

​
attachmentIds
string[]
​
references
object[]

Response

Task created.

​
taskId
string