SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Tasks

Change a key result. Planners and the goal owner can do this

PATCHhttps://app.softsolz.uk/api/v1/services/tasks/key-results/{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.

Body Params

titlestring

What is measured.

measurestring

How it is measured.

start_valuenumber | null

Value at the start.

target_valuenumber | null

Value to reach.

current_valuenumber | null

Latest value.

unitstring | null

Unit, or currency code for currency.

project_idinteger | null

Project, for the project measure.

Response

Response Body

idintegerKey result id.
goal_idintegerThe goal.
titlestringWhat is measured.
measurestringHow it is measured.
start_valuenumber | nullValue at the start.
target_valuenumber | nullValue to reach.
current_valuenumber | nullLatest value.
unitstring | nullUnit or currency code.
projectobject | nullProject, for the project measure, or null when there is none.
progress_percentintegerProgress, 0 to 100.

Request

curl --request PATCH \
--url https://app.softsolz.uk/api/v1/services/tasks/key-results/{id} \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

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": 31,
"goal_id": 9,
"title": "Weekly sign-ups",
"measure": "number",
"start_value": 1,
"target_value": 1,
"current_value": 1,
"unit": "your-unit",
"project": {
"id": 1,
"name": "your-name"
},
"progress_percent": 1
}
}