Skip to main content
POST
/
api
/
tasks
/
{id}
/
exit
Exit a task (HHD)
curl --request POST \
  --url https://clarus-api.com/api/tasks/{id}/exit \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "error": "<string>"
}

Behavior

This endpoint is used by handheld devices (HHDs) to release tasks they have entered.

State Transitions

Current StateAction
ALLOCATED (to current user)Sets status to AVAILABLE, clears user_id, assigned_at, start_at
AVAILABLEUpdates last_accessed_at only
COMPLETEDUpdates last_accessed_at only
  • Returns 204 No Content on success
  • No request body required

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

id
integer
required

The unique identifier of the task to exit

Response

Operation completed successfully with no content to return