Create a task

Creates a task.

POST /tasks

Create a task

cURL

curl --request POST \
  --url https://api.smokeball.com/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "matterId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "completedByStaffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "assigneeIds": [
    "<string>"
  ],
  "subject": "Review contract for John Smith",
  "note": "Contract needs to be reviewed and discussed with John",
  "isCompleted": false,
  "categories": [
    "<string>"
  ],
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15",
  "dueDate": "2020-02-15T13:00:00Z",
  "dueDateOnly": "2020-02-15",
  "duration": "PT4H33M"
}
'

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

staffId · string · required

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

Minimum string length: 1

Example:

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

matterId · string | null

Unique identifier of the matter associated to the task.

Example:

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

completedByStaffId · string | null

Unique identifier of the associated staff member completing the task.

Example:

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

assigneeIds · string[] | null

Unique identifier(s) of the associated staff member(s) assigned to the task.

subject · string | null

The subject - this should be a short description of the task.

Example:

"Review contract for John Smith"

note · string | null

Notes on the task.

Example:

"Contract needs to be reviewed and discussed with John"

isCompleted · boolean

True when the task is completed.

Example:

false

categories · string[] | null

Categories for the task.

completedDate · string<date-time> | null · deprecated

Deprecated. Use CompletedDateOnly instead.

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

Example:

"2020-02-15T13:00:00Z"

completedDateOnly · string<date-time> | null

Completed date of the task. 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:

"2020-02-15"

dueDate · string<date-time> | null · deprecated

Deprecated. Use DueDateOnly instead.

Due date of the task in UTC.

Example:

"2020-02-15T13:00:00Z"

dueDateOnly · string<date-time> | null

Due date of the task. Takes precendence over DueDate if set.

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

Example:

"2020-02-15"

duration · string | null

Duration of the task in ISO 8601 duration format.

Example:

"PT4H33M"

Response

202

application/json

When request is accepted. Returns a hypermedia 'Link' object of the task to be created.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET