Skip to content
Gospl Wiki

Edit a goal's title/description/type.

PATCH
/goals/{goalId}
 
curl --request PATCH \
  --url https://api.gospl.example/v1/goals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "description": "example", "type": "professional" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
title
string
>= 1 characters
description
string
type
string
Allowed values: professional personal

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated.

Media type application/json
object
id
required
string format: uuid
title
required
string
description
string
type
required
string
Allowed values: professional personal
status
required
string
Allowed values: active complete
weekStart
required

Anchors the goal to a week (G2).

string format: date
dateSet
required
string format: date-time
dateCompleted
string format: date-time
Example 
{
  "type": "professional",
  "status": "active"
}

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. cross-tenant, out-of-chain).

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"
}