SMsmokeball
Tasks

Update a subtask

Updates a specified subtask of a specified task.

put/tasks/{taskId}/subtasks/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/tasks/{taskId}/subtasks/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

taskIdstring uuid required
idstring uuid required

Request body

staffIdstring required

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

completedByStaffIdstring nullable

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

subjectstring required

Subject of the subtask.

isCompletedboolean

True when the subtask is completed.

completedDatestring date-time nullable

Deprecated. Use CompletedDateOnly instead.

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

completedDateOnlystring date-time nullable

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

Any time/timezone information will be discarded and only the date portion will be considered.

Example request

{
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "completedByStaffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "subject": "Confer with Mary",
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.