Skip to main content
PUT
/
tasks
/
{taskId}
/
subtasks
/
{id}
Update a subtask
curl --request PUT \
  --url https://api.smokeball.com/tasks/{taskId}/subtasks/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "completedByStaffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "subject": "Confer with Mary",
  "isCompleted": false,
  "completedDate": "2022-07-01"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
taskId
string<uuid>
required
​
id
string<uuid>
required

Body

Data transfer object for a subtask.

​
subject
string
required

Subject of the subtask.

Minimum length: 1
Example:

"Confer with Mary"

​
staffId
string | null

Unique identifier of the associated staff member creating or updating the subtask.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
completedByStaffId
string | null

Unique identifier of the associated staff member who completed the subtask.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
isCompleted
boolean

True when the subtask is completed.

Example:

false

​
completedDate
string<date-time> | null

Completed date of the subtask. If not provided and IsCompleted is set to true, the current date will be used.

Example:

"2022-07-01"

Response

202 - application/json

When request is accepted. Returns a hypermedia 'Link' object of the subtask to be updated.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET