Update a task. Provided keys are changed; array fields are replaced when present.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

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

titlestring

Task title (required, trimmed).

instructionsstring

What the assignee has to do.

category_idinteger

Category to file this under.

prioritystring

Urgency. Defaults to normal.

statusstring

Defaults to draft. Only published tasks are visible to assignees.

due_atstring

Default deadline.

schedule_modestring

Defaults to one_time. A recurring task is a definition and is never assigned directly; its occurrences are separate tasks.

starts_atstring

When a scheduled task opens.

submission_modestring

What must come back. Defaults to file_and_text.

required_filesinteger

Minimum files per submission.

allowed_submission_countinteger | null

Attempt cap; null means unlimited resubmissions.

allow_late_submissionboolean

Allow submitting past the deadline.

required_fieldsarray of strings

Ids of custom fields the assignee must fill in.

grading_schemestring

Overrides the category scheme. Omit to inherit.

max_scorenumber

Denominator for numeric schemes.

weightnumber

Weight in the category rollup. Defaults to 1.

rubricarray of objects

Criteria for the rubric scheme.

checklistarray of objects

Steps the assignee ticks off.

custom_fieldsobject

Values for workspace-defined fields.

expected_updated_atstring

Optimistic-concurrency guard; if it does not equal the stored updated_at the call returns 409 STALE_VERSION.

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, template, schedule).

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

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.tasks.updateTask('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "category_id": 0,
    "title": "string",
    "instructions": "string",
    "priority": "string",
    "status": "string",
    "due_at": "string",
    "schedule_mode": "string",
    "starts_at": "string",
    "submission_mode": "string",
    "required_files": 0,
    "allowed_submission_count": 0,
    "allow_late_submission": true,
    "grading_scheme": "string",
    "max_score": "string",
    "weight": 0,
    "rubric": [],
    "checklist": [],
    "attachments": [],
    "custom_fields": {},
    "source": "string",
    "template_id": 0,
    "assignment_count": 0,
    "created_at": "string",
    "updated_at": "string"
  }
}