Skip to main content
PATCH
/
api
/
v1
/
tasks
/
{uid}
Update One
curl --request PATCH \
  --url https://api.onfragment.com/api/v1/tasks/{uid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived": true,
  "status": "TODO",
  "status_global": "TODO",
  "legacy_data": {},
  "skills": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_email": "<string>",
  "participants": {},
  "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fields": {},
  "due_at": "2023-11-07T05:31:56Z",
  "snooze_expires_at": "2023-11-07T05:31:56Z",
  "metadata_form_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "form_data": {},
  "form_type": "<string>",
  "assigned_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "done_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_assigned_player": true,
  "external_created_at": "2023-11-07T05:31:56Z",
  "external_updated_at": "2023-11-07T05:31:56Z",
  "external_status": "TODO",
  "external_status_updated_at": "2023-11-07T05:31:56Z",
  "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived": true,
  "status": "TODO",
  "legacy_data": {},
  "skills": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participants": {},
  "case_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "due_at": "2023-11-07T05:31:56Z",
  "snooze_expires_at": "2023-11-07T05:31:56Z",
  "fields": {},
  "metadata_form_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "form_data": {},
  "form_type": "<string>",
  "assigned_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "done_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "assignee_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queue_updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_assigned_player": true,
  "internal_created_at": "2023-11-07T05:31:56Z",
  "internal_updated_at": "2023-11-07T05:31:56Z",
  "external_created_at": "2023-11-07T05:31:56Z",
  "external_updated_at": "2023-11-07T05:31:56Z",
  "external_status": "TODO",
  "external_status_updated_at": "2023-11-07T05:31:56Z",
  "external_assignee_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "queue_time": 123,
  "queue_time_business": 123,
  "work_time": 123,
  "work_time_business": 123,
  "incremental_work_time": 123,
  "incremental_work_time_business": 123,
  "resolution_time": 123,
  "resolution_time_business": 123,
  "num_children": 123,
  "num_children_done": 123,
  "queue_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sla_breach_at": "2023-11-07T05:31:56Z",
  "sla_breach_business_at": "2023-11-07T05:31:56Z",
  "wait_time": 123,
  "wait_time_business": 123,
  "review_status": "<string>",
  "task_type": "<string>",
  "played_at": "2023-11-07T05:31:56Z",
  "assignee": {
    "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "archived": true,
    "role": "super_admin",
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "skills": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "legacy_data": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "is_registered": true
  },
  "parent": "<unknown>",
  "children": [
    "<unknown>"
  ],
  "comments": [
    {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "archived": true,
      "task_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "author_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "blocks": [
        {
          "id": "<string>",
          "type": "<string>",
          "props": {},
          "content": [
            {
              "type": "<string>",
              "text": "<string>",
              "href": "<string>",
              "content": "<array>",
              "styles": {},
              "props": {}
            }
          ],
          "children": "<array>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "task": "<unknown>",
      "author": {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "archived": true,
        "role": "super_admin",
        "email": "[email protected]",
        "first_name": "<string>",
        "last_name": "<string>",
        "skills": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "legacy_data": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "is_registered": true
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
fragment-user-agent
string | null
​
fragment-account
string | null
​
fragment-versioning
string | null
​
fragment-user
string<uuid> | null

Path Parameters

​
uid
string<uuid>
required

Body

application/json

Task update schema, all columns can be unset.

​
uid
​
archived
​
status

Task Status Enum.

Available options:
TODO,
STARTED,
DONE
​
status_global

Task global status enum.

Available options:
TODO,
DONE
​
legacy_data
​
skills
​
queue_uid
​
assignee_uid
​
assignee_email
​
participants
​
case_uid
​
parent_uid
​
fields
​
due_at
​
snooze_expires_at
​
metadata_form_uid
​
form_data
​
form_type
​
assigned_at
​
started_at
​
done_at
​
created_at
​
updated_at
​
assignee_updated_by
​
queue_updated_by
​
is_assigned_player
​
external_created_at
​
external_updated_at
​
external_status

Task Status Enum.

Available options:
TODO,
STARTED,
DONE
​
external_status_updated_at
​
external_assignee_uid

Response

Successful Response

Task schema, same as Task Model.

​
uid
string<uuid>
required
​
archived
boolean
required
​
status
enum<string>
required

Task Status Enum.

Available options:
TODO,
STARTED,
DONE
​
legacy_data
Legacy Data · object
required
​
skills
string<uuid>[]
required
​
assignee_uid
string<uuid> | null
required
​
participants
Participants · object
required
​
case_uid
string<uuid> | null
required
​
parent_uid
string<uuid> | null
required
​
due_at
string<date-time>
required
​
snooze_expires_at
string<date-time> | null
required
​
fields
Fields · object
required
​
metadata_form_uid
string<uuid> | null
required
​
form_data
Form Data · object
required
​
form_type
string | null
required
​
assigned_at
string<date-time> | null
required
​
started_at
string<date-time> | null
required
​
done_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
assignee_updated_by
string<uuid> | null
required
​
queue_updated_by
string<uuid> | null
required
​
is_assigned_player
boolean | null
required
​
internal_created_at
string<date-time> | null
required
​
internal_updated_at
string<date-time> | null
required
​
external_created_at
string<date-time> | null
required
​
external_updated_at
string<date-time> | null
required
​
external_status
enum<string> | null
required

Task Status Enum.

Available options:
TODO,
STARTED,
DONE
​
external_status_updated_at
string<date-time> | null
required
​
external_assignee_uid
string<uuid> | null
required
​
queue_time
integer | null
required
​
queue_time_business
integer | null
required
​
work_time
integer | null
required
​
work_time_business
integer | null
required
​
incremental_work_time
integer | null
required
​
incremental_work_time_business
integer | null
required
​
resolution_time
integer | null
required
​
resolution_time_business
integer | null
required
​
num_children
integer
required
​
num_children_done
integer
required
​
queue_uid
string<uuid> | null
​
sla_breach_at
string<date-time> | null
​
sla_breach_business_at
string<date-time> | null
​
wait_time
integer | null
​
wait_time_business
integer | null
​
review_status
string | null
​
task_type
string | null
​
played_at
string<date-time> | null
​
assignee
User · object

User Schema.

​
parent
unknown
​
children
any[] | null
​
comments
TaskComment · object[] | null