POST
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

Body

application/json
title
string
required

Short imperative title for the task, 1-500 characters.

Required string length: 1 - 500
description
string

Plain-text description used for search, card excerpts, and previews. Up to 10,000 characters.

Maximum string length: 10000
descriptionDoc
any[] | null

Rich (block-based) description document, stored verbatim for the task editor. Send null to clear it. Keep the plain-text description field in sync for search and previews.

workflowStatusId
string<uuid>

Workspace-owned task workflow status id. Omit on create to use the first not_started task status.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
status
enum<string>

Legacy task-state projection retained for checklist and summary compatibility. The workspace workflow status is authoritative.

Available options:
todo,
in_progress,
done
dueAt
string | null

ISO-8601 instant the task is due. Send null to clear the due date; tasks with a due date also appear on the calendar.

contentItemId
string<uuid> | null

Id of the post this task is attached to (its checklist), as returned by the list posts endpoint. Send null to detach; attached tasks are removed with their post.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
assigneeUserIds
string<uuid>[]

Full replacement set of team-member user ids assigned to the task; an empty array clears every assignment. Non-members are silently ignored.

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
tagIds
string<uuid>[]

Full replacement set of registry tag ids on the task (same registry as post tags); an empty array clears them. Tags from other teams are silently ignored.

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
teamId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
title
string
required
description
string | null
required
descriptionDoc
any[] | null
required
workflowStatusId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
status
enum<string>
required
Available options:
todo,
in_progress,
done
dueAt
string | null
required
contentItemId
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
contentItemTitle
string | null
required
assignees
object[]
required
tags
object[]
required
createdBy
string<uuid> | null
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
createdAt
string
required
updatedAt
string
required