Skip to main content
PUT
Update a task
Updates only the task fields you supply and returns the updated task. The store is bound to your app token server-side — never send a shop id.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

id
string
required

The task's id (Mongo ObjectId).

Body

application/json
title
string

Task title.

details
string

Free-text task details.

dueDate
string<date-time> | null

When the task is due (ISO 8601), or null.

status
enum<string>

Task status.

Available options:
to do,
in progress,
done,
skipped
recurring
enum<string>

Recurrence cadence.

Available options:
none,
daily,
weekly,
monthly
recurringSchedule
object

Recurrence schedule. Required when recurring is daily, weekly or monthly.

isAI
boolean

Whether the task was generated by AI.

assignees
string[]

User ObjectId strings assigned to the task.

Response

The updated task.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A task belonging to the store.