Skip to content

Mark a goal complete (inline card action).

POST
/goals/{goalId}/complete
curl --request POST \
--url https://api.gospl.example/v1/goals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/complete \
--header 'Authorization: Bearer <token>'
goalId
required
string format: uuid

Completed.

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

Missing/invalid credentials.

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

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

Not found within the caller’s tenant.

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