Move a task through its own lifecycle. Pausing hides it from assignees; cancelling cascades a cancel to open assignments.

POSThttps://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/status

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

statusstringrequired

Target status.

reasonstring

Recorded against every affected assignment.

Response

Response Body

idintegerTask id.

category_idinteger | nullCategory this task belongs to.

titlestringTask title.

instructionsstring | nullWhat the assignee has to do.

prioritystringUrgency of the work.

statusstringTask lifecycle, separate from assignment status. Paused hides the task from assignees; cancelled cascades to open assignments.

due_atstring | nullDefault deadline, overridable per assignment.

schedule_modestringone_time exists once, scheduled starts at starts_at, recurring is a definition that generates occurrences.

starts_atstring | nullWhen a scheduled task becomes visible to assignees.

submission_modestringWhat the assignee must send back.

required_filesintegerMinimum number of files a submission must carry.

allowed_submission_countinteger | nullMaximum attempts; null means unlimited resubmissions.

allow_late_submissionbooleanWhether work may still be submitted after the deadline.

grading_schemestring | nullOverrides the category scheme; null inherits it.

max_scorenumber | nullDenominator for points, percentage and letter schemes.

weightnumberWeight of this task in its category rollup. Defaults to 1.

rubricarray of objectsCriteria for the rubric scheme: { id, label, max_score, weight }.

checklistarray of objectsSteps the assignee ticks off: { id, label, required, requires_note, requires_file }.

attachmentsarray of objectsReference material supplied with the task.

custom_fieldsobjectValues for the workspace-defined fields on this task.

sourcestringWhere the task came from: manual, api, form, chat, webhook, appointment, template, schedule, outreach or seo.

template_idinteger | nullThe template this task was created from.

assignment_countintegerHow many people this task is assigned to.

created_atstringCreation timestamp.

updated_atstringRound-trip as expected_updated_at to guard against stale writes.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/tasks/tasks/{id}/status \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "paused",
  "reason": "Site closed for refurbishment."
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "id": 42,
    "category_id": 7,
    "title": "Quarterly safety inspection",
    "instructions": "Walk every floor and photograph each extinguisher.",
    "priority": "high",
    "status": "published",
    "due_at": "2026-09-01T17:00:00.000Z",
    "schedule_mode": "one_time",
    "starts_at": null,
    "submission_mode": "file_and_text",
    "required_files": 1,
    "allowed_submission_count": 3,
    "allow_late_submission": true,
    "grading_scheme": null,
    "max_score": 100,
    "weight": 2,
    "rubric": [
      {
        "id": "accuracy",
        "label": "Accuracy",
        "max_score": 40,
        "weight": 1
      }
    ],
    "checklist": [
      {
        "id": "floor-1",
        "label": "Floor 1 complete",
        "required": true
      }
    ],
    "attachments": [
      {
        "filename": "report.pdf",
        "mime": "application/pdf",
        "size_bytes": 184320,
        "download_url": "https://s3.eu-west-2.amazonaws.com/...",
        "content_url": "/api/services/tasks/files/content?key=tasks%2F..."
      }
    ],
    "custom_fields": {
      "property": "Riverside House",
      "inspection_type": "annual"
    },
    "source": "api",
    "template_id": null,
    "assignment_count": 12,
    "created_at": "2026-08-01T09:00:00.000Z",
    "updated_at": "2026-08-02T11:15:00.000Z"
  }
}