Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

PATCH/timers/{timer}

Correct a timer

PATCHhttps://<your-url>/api/v2/timers/{timer}

MCP id timers.updateAlso on this path: GET Read a timer, DELETE Discard a timer

View as Markdown openapi.json

Partially updates a timer: absent keys are untouched, an empty body is rejected.

Access

Token scope
api:write:hours

Without it: 403 insufficient-token-scope.

Permission
None. The record's own rules still apply.
Rate cost
1 unit, write bucket. A write costs the same whatever view you ask for.
Also
Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

started_at is the only writable key; correcting a mis-started stopwatch is the whole purpose. The timeable_type / timeable_id pair is never accepted on a PATCH, so retargeting a timer is a DELETE followed by a POST. user_id is not accepted either, so a timer cannot be moved to another employee. Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Treat it as best-effort only: this resource carries no concurrency token, and updated_at is second-precision, so two writes inside the same second are indistinguishable. This operation declares no permission of its own: you may change your own timers, and changing another employee's timer additionally requires times::update_others.

Path parameters

timerintegerRequired

The Timer's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

started_attimestamp (YYYY-MM-DDThh:mm:ssZ)

When the stopwatch was started. Elapsed time is this value against the client's own clock; the API publishes no elapsed counter.

Response 200

Returns a Timer in the detail view.

Headers

ETag
A strong validator of exactly this representation.
RateLimit
The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy
The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id
The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

Errors

7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503

This path allows GET, PATCH, DELETE. Anything else answers 405.