Skip to content
Docs

Set a goal

POST
/api/workspaces/{ws}/goals

status "done" needs evidence: a link, an id the system can show, or a number and where it came from.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

Request Body

application/json
  1. body
positionId*string
Length1 <= length <= 100
title*string
Length1 <= length <= 200
measure?string
Lengthlength <= 200
Default""
target?string
Lengthlength <= 200
Default""
current?string
Lengthlength <= 200
Default""
dueOn?|
Defaultnull
status?string
Default"active"
Value in"proposed""active""done""dropped"
evidence?string
Lengthlength <= 2000
Default""
note?string
Lengthlength <= 2000
Default""

Response Body

The goal.

Example Request
curl -X POST 'https://app.useroster.work/api/workspaces/string/goals' \  -H 'Content-Type: application/json' \  -d '{  "positionId": "string",  "title": "string"}'
Example Response
Empty