Tasks

Update a task

Updates a task and keeps its card-checklist mirror entry in sync.

The update is attributed to a user who must belong to the company. With a delegate token the user is taken from the token. With an API key (no associated user), supply userId in the body — it must belong to the company or the request is rejected.

put/api/tasks/{taskId}

Request

Base URL
https://core-api.getaptly.com
Auth
- API key in header x-token
- or API key in header Authorization
TypeScript
https://skmtc.dev/getaptly/apis/aptly-api/docs/api/tasks/:taskId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

taskIdstring required

Request body

userIdstring

Acting user the update is attributed to. Required with API-key auth (must belong to the company); ignored with a delegate token, which supplies the user itself.

titlestring

descriptionstring

checkedboolean

dueAtstring date-time

statusstring

One of backlog|notStarted|inProgress|onHold|completed.

prioritystring

One of asap|high|medium|low.

assigneeIdstring

archivedboolean

archivedAtstring date-time

startedAtstring date-time

checkedAtstring date-time

pinnedboolean

ranknumber

attachmentIdsstring[]

outcomeTypestring

aptletInstanceIdstring

fieldIdstring

Response

Task updated.

okboolean

Changes

No recorded changes to this operation across all 1 revision of this API.