SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
tasks

Update a category. Changing the grading scheme re-renders existing reviews, because only raw scores are stored.

Update a category. Changing the grading scheme re-renders existing reviews, because only raw scores are stored.

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

Recent Requests

Log in to see full request history
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

namestring

New name.

Response

Response Body

idintegerCategory id.
namestringWhat this category is called.
colourstring | nullToken name used to tint the category.
sort_orderintegerDisplay order.
grading_schemestringDefault scheme for tasks in this category.
pass_marknumber | nullThreshold for pass_fail, as a percentage.
letter_bandsarray of objectsBands for the letter scheme: { label, min_percent }, highest first.
reminder_leadarray of stringsHow far ahead to remind, as a list. Overrides the workspace default.
task_countintegerTasks filed under this category.

Request

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


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


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

Credentials

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

Response · 200

{
  "data": {
    "id": 0,
    "name": "string",
    "colour": "string",
    "sort_order": 0,
    "grading_scheme": "string",
    "pass_mark": "string",
    "letter_bands": [],
    "reminder_lead": [],
    "task_count": 0
  }
}