Skip to main content
POST
Create a project

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 project's own shape: standard keys at the top level, custom keys under fields. title is required.

account
string

The id of the account the project is on

assignee
string

A user's id

description
string

Free text

due_date
string<date>

YYYY-MM-DD; 30 days from now when not sent; not with a template, which sets it

fields
Fields · object | null

Custom field keys to values

priority
enum<string>

low, medium or high

Available options:
low,
medium,
high
start_date
string<date>

YYYY-MM-DD; today (US Pacific) when not sent

template
string

A template's id (GET /v1/project_templates): the project is made from it, its tasks included

title
string

Required: the project's name

Response

201 - application/json

Successful Response

A new project, and what its create from a template could not do.

id
string
required
account
string | null

The id of the account the project is on

account_name
string | null
assignee
string | null

The assignee's user id

created_at
string | null
creator
string | null

The creator's user id

description
string | null
due_date
string | null
fields
Fields · object
priority
enum<string> | null
Available options:
low,
medium,
high
source
string | null
start_date
string | null
status
string | null
status_group
enum<string> | null
Available options:
not_started,
active,
done,
archived
template
string | null

The id of the template the project was created from

title
string | null
updated_at
string | null
warnings
string[]

What a create from a template skipped: a template task the task create refused (its subtasks are then created at the top level, each named too), a task created without its custom values, or a custom field the template names that no longer exists. Empty when nothing was