PATCH
/
tasks
/
curl --location --request PATCH 'https://api.travtus.com/task/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "identifier": "2b1d4c71-766c-4834-a671-bea629e9af39",
    "status": "completed",
    "due_datetime": "2023-11-11 20:00:00",
    "notes": "Some notes"
}'

{
    "request_id": "5dc8327b-ebcb-4185-a0d0-5a5d40c56ed2"
}

This endpoint allows you to update a task with provided details.

You must provide either identifier parameter or an external reference via the external_ref attribute.

All datetime fields included in the body parameters need to be specified as ISO8601-formatted date strings.

Datetime fields should follow a “YYYY-MM-DDThh:mm:ss” format.

​
Authorization
string
default:"none"
required

The authentication token for your request

​
Body

​
identifier
string
default:"none"

The identifier of a task to use for updating a task.

Please note you can either use the identifier or external_ref to update a task.

​
external_ref
string
default:"none"

The external reference of a task to use for updating a task.

Please note you can either use the identifier or external_ref to update a task.

​
status
enum
default:"none"

The status of a task.

Possible values: created, in_progress, completed, or deleted

​
due_datetime
datetime
default:"none"

The due date of the task. Example: 2023-01-01T00:00:00

​
reminder_datetime
string
default:"none"

The reminder date of a task. Example: 2023-01-01T00:00:00

​
completed_datetime
string
default:"none"

The completed date of the task. Example: 2023-01-01T00:00:00

​
importance
enum
default:"none"

The importance of the task. Possible value: low, normal, high, very_high.

​
assignee_id
string
default:"none"

The identifier of task assignee. You can use this field to update the task assignee.

​
resident_id
string
default:"none"

The identifier of the resident that the task is targeted for. You can use this field to update the task resident.

​
notes
string
default:"none"

The notes of the task.

​
title
string
default:"none"

The title of the task.

​
description
string
default:"none"

The description of the task.

​
Response

​
request_id
string

The UUID of the request. We handle requests asynchronously, the task update result will be sending by webhook event. You can use this ID to lookup webhook event on consumer application portal.

curl --location --request PATCH 'https://api.travtus.com/task/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "identifier": "2b1d4c71-766c-4834-a671-bea629e9af39",
    "status": "completed",
    "due_datetime": "2023-11-11 20:00:00",
    "notes": "Some notes"
}'

{
    "request_id": "5dc8327b-ebcb-4185-a0d0-5a5d40c56ed2"
}