Skip to content
Gospl Wiki

Edit an own summary (scores/text/week).

PATCH
/summaries/{summaryId}
 
curl --request PATCH \
  --url https://api.gospl.example/v1/summaries/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "weekStart": "2026-04-15", "scores": { "qualityOfWork": 1, "personalWellbeing": 1, "professionalWellbeing": 1 }, "proud": "example", "obstacles": "example", "learned": "example", "important": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
summaryId
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
object
weekStart
required
string format: date
scores
required
object
qualityOfWork
required
integer
>= 1 <= 5
personalWellbeing
required
integer
>= 1 <= 5
professionalWellbeing
required
integer
>= 1 <= 5
proud
required

Rich text.

string
obstacles
required
string
learned
required
string
important
required
string
Example generated
{
  "weekStart": "2026-04-15",
  "scores": {
    "qualityOfWork": 1,
    "personalWellbeing": 1,
    "professionalWellbeing": 1
  },
  "proud": "example",
  "obstacles": "example",
  "learned": "example",
  "important": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated.

Media type application/json
object
id
required
string format: uuid
user
required
object
id
required
string format: uuid
name
required
string
team
string
weekStart
required
string format: date
scores
required
object
qualityOfWork
required
integer
>= 1 <= 5
personalWellbeing
required
integer
>= 1 <= 5
professionalWellbeing
required
integer
>= 1 <= 5
proud
string
obstacles
string
learned
string
important
string
createdAt
required
string format: date-time
response
object
id
required
string format: uuid
manager
required
object
id
required
string format: uuid
name
required
string
team
string
body
required
string
createdAt
required
string format: date-time
Example generated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "user": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "team": "example"
  },
  "weekStart": "2026-04-15",
  "scores": {
    "qualityOfWork": 1,
    "personalWellbeing": 1,
    "professionalWellbeing": 1
  },
  "proud": "example",
  "obstacles": "example",
  "learned": "example",
  "important": "example",
  "createdAt": "2026-04-15T12:00:00Z",
  "response": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "manager": {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "team": "example"
    },
    "body": "example",
    "createdAt": "2026-04-15T12:00:00Z"
  }
}

401

Section titled “401 ”

Missing/invalid credentials.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}

403

Section titled “403 ”

Authenticated but not permitted (incl. out-of-chain, cross-tenant).

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}

404

Section titled “404 ”

Not found within the caller’s tenant.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}