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

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

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

curl --request PATCH \
  --url https://app.softsolz.uk/api/v1/services/tasks/categories/{id} \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Health and safety"
}'

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": 7,
    "name": "Safety",
    "colour": "amber",
    "sort_order": 10,
    "grading_scheme": "pass_fail",
    "pass_mark": 50,
    "letter_bands": [
      {
        "label": "A",
        "min_percent": 90
      },
      {
        "label": "B",
        "min_percent": 80
      }
    ],
    "reminder_lead": [
      "24h",
      "1h"
    ],
    "task_count": 18
  }
}