Skip to main content
PATCH
Update a task

Authorizations

Authorization
string
header
required

A group API key, sent as Authorization: Bearer sw_live_…. Keys from staging and the demo start sw_test_ instead. A group admin creates keys in Settings → Integrations → API keys.

Path Parameters

taskId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Send only the fields to change. A field not listed here is refused with a 400.

columnId
string<uuid>

Move the task to another column on its board. Into the done column completes it; out of it reopens it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
string
Required string length: 1 - 255
description
string | null

Notes, up to 5,000 characters. Shown in Scoutworks. Free text never leaves through the API, so it is not returned.

Maximum string length: 5000
priority
enum<string>
Available options:
low,
medium,
high,
urgent
dueDate
string<date-time> | null

When it is due, ISO 8601. Null for no due date.

labelIds
string<uuid>[]

Labels from the task’s board (GET /task-boards). Replaces the task’s labels; an id not on the board is refused.

Maximum array length: 20
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
{key}
any

Response

OK

data
object
required
{key}
any