Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json

A create body in the task's own shape: standard keys at the top level, custom keys under fields. title and one of account / project are required.

account
string

The id of the account the task is on; a task in a project is on the project's account

assignee
string

A user's id, or a contact of the task's account

description
string

Free text

due_date
string<date>

YYYY-MM-DD

fields
Fields · object | null

Custom field keys to values

parent
string

The id of the parent task, in the same project

priority
enum<string>

low, medium or high

Available options:
low,
medium,
high
project
string

The id of the project the task is in

start_date
string<date>

YYYY-MM-DD

status
string

A status name from the task's own status template; its TODO (else first not-started) status when not sent

title
string

Required: the task's title

type
enum<string>

activity_task (the default, as the app creates tasks), or for a task in a project also project or milestone; a task on an account takes any type but project and milestone

Available options:
activity_task,
risk_mitigation,
expansion,
key_next_step,
escalation,
project,
milestone

Response

201 - application/json

Successful Response

id
string
required
account
string | null

The id of the account the task is on

account_name
string | null
activity
string | null

The id of the activity the task came from

assignee
string | null

The assignee's id: a person's

assignee_name
string | null
assignee_type
enum<string> | null

user (a teammate), contact, vendor or digital_worker; null when unknown

Available options:
user,
contact,
vendor,
digital_worker
created_at
string | null
creator
string | null

The id of the user who created the task

description
string | null
due_date
string | null
fields
Fields · object
parent
string | null

The id of the parent task

priority
enum<string> | null
Available options:
low,
medium,
high
project
string | null

The id of the project the task is in

project_name
string | null
start_date
string | null
status
string | null
status_group
enum<string> | null
Available options:
not_started,
active,
done,
archived
title
string | null
type
enum<string> | null
Available options:
activity_task,
risk_mitigation,
expansion,
key_next_step,
escalation,
project,
milestone
updated_at
string | null