Tasks

Update many tasks

Applies one update to up to 100 tasks: either an explicit taskIds list (archived tasks included, so they can be un-archived), or every non-archived task on a card (aptletInstanceId) — open tasks only unless includeCompleted is true. Each task is updated exactly as PUT /api/tasks/{taskId} would update it (card checklist, assignment notifications and completion workflows included).

Use archived: true to close or skip tasks, checked: true to complete them. One task failing does not stop the others; it is listed in failed. A task on a board outside an API key's board allowlist is reported as FORBIDDEN.

post/api/tasks/bulk-update

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/bulk-update/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

userIdstring

Acting user the updates are attributed to. Required with API-key auth; ignored with a delegate token, which supplies the user itself.

taskIdsstring[]

Tasks to update. Provide this or aptletInstanceId.

aptletInstanceIdstring

Update every task on this card instead of a taskIds list.

includeCompletedboolean

With aptletInstanceId, also update completed tasks.

Response

Which tasks were updated and which were not.

updatedstring[]

Example response

{
  "failed": [
    {
      "code": "FORBIDDEN"
    }
  ]
}

Changes

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