Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PATCH https://api.zinndigital.com/v1/agency/time/tasks/{taskId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ Archives; never deletes, and the database enforces it — `TimeEntry.task` is `PROTECT`ed, so a task with hours against it cannot be removed. Deleting one would orphan the record of what those hours were for.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
taskId (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | No | — |
archived | boolean | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
project_id | string | Yes | — |
name | string | Yes | — |
archived | boolean | Yes | — |
fixed_price_billed | boolean | Yes | Whether this task's FIXED price has already been invoiced. Surfaced so the screen can say "already billed" rather than showing further hours on it as free work. |
Errors this endpoint can return
401 · 403 · 404