Skip to main content
POST
https://api.travtus.com
/
tasks
curl --location --request Post 'https://api.travtus.com/task/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "group_external_ref": "group-1",
    "due_datetime": "2023-11-11 20:00:00",
    "notes": "Some notes"
}'

{
    "request_id": "5dc8327b-ebcb-4185-a0d0-5a5d40c56ed2"
}
This endpoint allows you to create a task. You can provide either a group id through the group_id parameter or a group external reference through the group_external_ref attribute. Do not provide both, as this will result in the request failing. 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

​
group_id
string
default:"none"
The id of the group you want to create the task for.
​
group_external_ref
string
default:"none"
The external reference of the group you want to create the task for.
​
external_ref
string
default:"none"
The external reference of the task.
​
due_datetime
datetime
default:"none"
The due date of the task. Example: 2023-01-01T00:00:00
​
reminder_datetime
datetime
default:"none"
The reminder date of a task. Example: 2023-01-01T00:00:00
​
importance
enum
default:"none"
The importance of the task. Possible value: low, normal, high, very_high.
​
relevant_conversation
enum
default:"none"
The conversation that led to the creation of a task record.
​
creator
object
default:"none"
The tasks’s creator.Please note that if you specify a creator you must specify either:
  • an identifier or external_ref for the person
  • OR:
    • an email address or phone number
    • a first name or last name
​
assignee
object
default:"none"
The person assigned to deal with the tasks.Please note that if you specify an assignee you must specify either:
  • an identifier or external_ref for the person
  • OR:
    • an email address or phone number
    • a first name or last name
​
resident
object
default:"none"
The person record of the resident for which the task is being created.Please note that if you specify a resident you must specify either:
  • an identifier or external_ref for the person
  • OR:
    • an email address or phone number
    • a first name or last name
​
unit_id
string
default:"none"
The identifier of the unit that the task is targeted for.
​
unit_external_ref
string
default:"none"
The external reference of the unit that the task is targeted for.
​
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.
​
identifier
string
The UUID of the created task.
curl --location --request Post 'https://api.travtus.com/task/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "group_external_ref": "group-1",
    "due_datetime": "2023-11-11 20:00:00",
    "notes": "Some notes"
}'

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