POST
/
tasks
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 '{
  "matterId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "staffId": "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": "2022-07-01",
  "dueDate": "2022-07-01",
  "duration": "PT4H33M"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Body

​
matterId
string | null

Unique identifier of the matter associated to the task.

Example:

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

​
staffId
string | null

Unique identifier of the associated staff member creating or updating 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 | null

Completed date of the task.

Example:

"2022-07-01"

​
dueDate
string | null

Due date of the task.

Example:

"2022-07-01"

​
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