Skip to content
Unless Docs

Rest API

Update a task

PUT
/api/v1/tasks

Update an existing task. Only the fields present in the body are changed, everything else is left as is.

Use cases

  • Task management: Mark a task as done after completing it, or reopen it
  • Assignment: Assign a task to a team member by email, or unassign it with an empty assignee
  • Editing: Adjust the name, description or data of a task

Notes

  • taskId and websiteId are required in the body
  • Change the task state by setting state to open, done or deleted
  • Use the get tasks endpoint first to find the taskId

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
x-api-key
required
string

Your API key from account settings.

x-user-email
required
string

The email address of your user.

x-account-id
required
string

The ID of your account. You can find this in the account settings.

x-website-id
required
string

The ID of the workspace you want to use.

Request Body required

Section titled “Request Body required ”
object
taskId
required

ID of the task to update.

string
websiteId
required

The website the task belongs to.

string
state

New state of the task.

string
Allowed values: open done deleted
name

New title of the task.

string
description

New description of the task.

string
assignee

Email address to assign the task to. Pass an empty string to unassign.

string
data

Replacement structured payload for the task.

object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The updated task.

object
task
object
accountId

The account ID that owns this task.

string
taskId

Unique identifier for this task.

string
name

Short title of the task.

string
description

Longer explanation of what the task is about.

string
nullable
type

The kind of work this task represents.

string
Allowed values: knowledge-suggestion knowledge-gap-detected review-flagged-conversation new-sales-opportunity retention-warning sales-expansion-opportunity wiki-suggestion maturity-task
source

Where the task originated.

string
Allowed values: team-assistant ai dashboard ingestion slack
state

Current state of the task.

string
Allowed values: open done deleted
data

Arbitrary structured payload attached to the task, depends on the task type.

object
assignee

Email address of the user the task is assigned to.

string
nullable
websiteId

The website this task belongs to.

string
nullable
createdAt

Unix timestamp (ms) when the task was created.

number
updatedAt

Unix timestamp (ms) when the task was last updated.

number

401

Section titled “401 ”

Unauthorized - invalid API key.