POST/api/v1/activities/ad-hoc/{id}/done

Product availabilityAlgaPSA

Toggle ad-hoc activity done

Marks an ad-hoc item done/undone. `done: true` sets status to closed; `done: false` reopens it (status scheduled). Requires the caller to be an assignee, or hold `user_schedule:update` / `user_schedule:read_all`.

Path parameters

idstringRequired

Ad-hoc activity identifier (the backing schedule entry id).

Request body

Content type: application/json · schema SetAdHocActivityDoneBodyV1

donebooleanRequired

Response body

Success response 200 · schema AdHocActivityResponseV1

dataobjectRequired

idstringRequired

titlestringRequired

descriptionstring

typestringRequired

Enum: scheduleprojectTasktickettimeEntryworkflowTasknotificationdocument

statusstringRequired

statusColorstring

prioritystringRequired

Enum: lowmediumhigh

priorityNamestring

priorityColorstring

dueDatestring

startDatestring

endDatestring

assignedToarray of string

itemsstring

assignedToNamesarray of string

itemsstring

sourceIdstringRequired

sourceTypestringRequired

Enum: scheduleprojectTasktickettimeEntryworkflowTasknotificationdocument

actionsarray of objectRequired

itemsobject

idstringRequired

labelstringRequired

iconstring

disabledboolean

disabledReasonstring

isClosedboolean

tenantstringRequired

createdAtstringRequired

updatedAtstringRequired

metaany

Response codes

200

Updated ad-hoc activity.

400

Invalid request body (e.g. missing `done`).

401

Authentication required.

403

Permission denied.

404

Ad-hoc activity not found.

500

Unexpected failure updating the ad-hoc activity.

POST /api/v1/activities/ad-hoc/{id}/done

cURL

curl -X POST "https://algapsa.com/api/v1/activities/ad-hoc/{id}/done" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "done": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/activities/ad-hoc/{id}/done", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "done": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/activities/ad-hoc/{id}/done");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""done"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "id": "string",
    "title": "string",
    "description": "string",
    "type": "schedule",
    "status": "string",
    "statusColor": "string",
    "priority": "low",
    "priorityName": "string",
    "priorityColor": "string",
    "dueDate": "string",
    "startDate": "string",
    "endDate": "string",
    "assignedTo": [
      "string"
    ],
    "assignedToNames": [
      "string"
    ],
    "sourceId": "string",
    "sourceType": "schedule",
    "actions": [
      {
        "id": "string",
        "label": "string",
        "icon": "string",
        "disabled": false,
        "disabledReason": "string"
      }
    ],
    "isClosed": false,
    "tenant": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "meta": null
}