Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

A Parley API key.

Body

application/json
title
string
required

Task title.

Required string length: 1 - 500
status
enum<string>

Defaults to todo.

Available options:
todo,
in_progress,
done,
cancelled
assigneeId
string

The ID of an active user in the organization to assign it to.

Minimum string length: 1
dueDate
string<date>

The day the task is due, as YYYY-MM-DD.

description
string

Details, up to 2,000 characters.

Required string length: 1 - 2000
linkedRecord
object

The project, account, or contact the task is about, as { type, id }. A project must be one you can edit.

reminder
object

Your reminder for the task, as { remindAt }.

fields
object

Custom field values to set on the task, keyed by field name or ID. A value replaces the current one, null clears it, and fields you don't mention are left alone. Each value must match its field's type: a string for text, long_text, email, url, single_select (one of the field's options), and user (the id of an active user in the organization); a number; true or false; an ISO 8601 date-time or YYYY-MM-DD date; a list of strings for collection ([] clears it); or { streetAddress, cityTown, state, country } for address. At most 50 fields. Status, assignee, due date, and description are properties of the task, not fields.

Response

Created.

id
string
required

The task ID.

Minimum string length: 1
title
string
required

Task title.

Required string length: 1 - 500
status
enum<string> | null
required

Where the task stands: todo, in_progress, done, or cancelled, or null when it has no status. done and cancelled close it.

Available options:
todo,
in_progress,
done,
cancelled
assignee
object | null
required

The person the task is assigned to, or null.

dueDate
string<date> | null
required

The day the task is due, as YYYY-MM-DD, or null.

description
string | null
required

Details, or null.

linkedRecord
object | null
required

The project, account, or contact the task is about, or null.

reminder
object | null
required

Your reminder for the task, or null. Reminders are personal: each person sees only their own.

createdAt
string<date-time>
required

When the task was created.

updatedAt
string<date-time>
required

When the task was last renamed or linked to a different record. Changes to its status, assignee, due date, description, field values, and reminders do not change it.

fields
object
required

Custom field values, keyed by field name, with a key for every field defined for tasks (null when unset). The value's shape follows the field's type. Status, assignee, due date, and description are properties of the task, not fields.