UPDATE Employee Task

API documentation for updating employee task activity with start and end times

UPDATE Employee Task

Update employee task activity by setting start and end times.

Parameters

  • employeeTaskId - ULID like string - mandatory
  • startedAt - datetime - mandatory
  • endedAt - datetime - mandatory

Permissions & Access

Minimum Role Required: Employee

Permissions: Users can edit / edit & finish employee tasks if they have edit permissions over the shift to which the task belongs.

API Endpoint

Edit | Edit & Finish Employee Task

Method: PUT
URL: {baseUrl}/api/v2/employee-tasks/{employeeTaskId}/activity?access_token={token}

Request Example

{
    "startedAt": "2025-10-08T10:30:00+00:00",
    "endedAt": "2025-10-08T12:00:00+00:00"
}

Response Example

{
    "status": 1,
    "data": {
        "activity": {
            "startedAt": "2025-10-08T10:30:00+00:00",
            "endedAt": "2025-10-08T12:00:00+00:00",
            "startedBy": 2,
            "endedBy": 2,
            "status": 2
        }
    },
    "metadata": [],
    "token": "token",
    "error": null
}

Response Fields

  • status - Response status code
  • data.activity.startedAt - Task start timestamp
  • data.activity.endedAt - Task end timestamp
  • data.activity.startedBy - User ID who started the task
  • data.activity.endedBy - User ID who ended the task
  • data.activity.status - Task status (2 = completed)
  • token - Authentication token
  • error - Error information (null if successful)
Language
Credentials
Query
Click Try It! to start a request and see the response here!