Skip to main content
POST
Create planner item

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
title
string
required

Item title (required)

Required string length: 1 - 255
description
string

Item description

Maximum string length: 10000
companyId
string<uuid>

Company ID

typeId
string<uuid>

Planner item type ID

status
enum<string>

Status (default: Not Started)

Available options:
In Progress,
Not Started,
Completed,
On Hold,
Cancelled,
Pending Approval
businessValue
enum<string>

Business value (default: Medium)

Available options:
High,
Medium,
Low
hours
number

Estimated hours (default: 0)

Required range: x >= 0
costEstimate
number

Cost estimate (default: 0)

Required range: x >= 0
probability
number

Completion probability (default: 50)

Required range: 0 <= x <= 100
startDate
string<date-time>

Start date (ISO 8601)

dueDate
string<date-time>

Due date (ISO 8601)

endDate
string<date-time>

End date (ISO 8601)

publicNotes
string

Public notes

Maximum string length: 10000
privateNotes
string

Private notes (internal only)

Maximum string length: 10000
isArchived
boolean

Whether the item is archived (default: false)

Response

Planner item created successfully

data
object
required