Deletes PSA projects in bulk, archiving them by default.

POST /psa/projects/bulk-delete

Group: PSA › Projects · Operation ID: deletePsaProjects

Deletes PSA projects and their timetracking data. By default this archives them, which you can undo with POST psa/projects/bulk-restore. Pass irreversible to delete permanently instead, which cannot be undone. This is all-or-nothing: if any id fails, nothing is deleted. To delete a single project use DELETE psa/projects/:id, which always archives, so irreversible is available only here. The response is empty.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: deletePsaProjectsInput.

Field Type Required Description
ids array of string yes The unique identifiers of the projects to delete. If any id does not match a project, nothing is deleted.
irreversible boolean no Whether to delete the projects permanently. Defaults to false, which archives them instead. Archived projects can be restored with POST psa/projects/bulk-restore.

Example:

{
  "ids": [
    "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "e57a0d34-9f62-4b18-bc25-71a6e8039d4b"
  ],
  "irreversible": true
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses