Skip to main content
PATCH
/
api
/
v1
/
tasks
/
{id}
Update task
curl --request PATCH \
  --url https://shelfforce.ai/api/v1/tasks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "pending",
  "assignedTo": "<string>",
  "notes": "<string>",
  "dueDate": "2023-12-25"
}
'
{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "status": "pending",
    "updatedAt": "2023-11-07T05:31:56Z",
    "placeId": "<string>",
    "assignedTo": "<string>",
    "dueDate": "2023-12-25",
    "notes": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Headers

Idempotency-Key
string

Unique key for idempotent requests. If a request with the same key was already processed within the last 24 hours, the cached response is returned with X-Idempotent-Replayed: true.

Example:

"idk_550e8400-e29b-41d4-a716-446655440000"

Path Parameters

id
string
required

Task ID.

Example:

"tsk_xyz789"

Body

application/json
status
enum<string>

New status. Must follow valid transition rules.

Available options:
pending,
in_progress,
completed,
cancelled
Example:

"in_progress"

assignedTo
string

User ID to reassign the task to.

Example:

"usr_qrs789"

notes
string

Updated notes.

Example:

"Completed verification. Display looks correct."

dueDate
string<date>

Updated due date.

Example:

"2026-03-20"

Response

Task updated.

data
object
required