Skip to content
Docs

Change a goal

PATCH
/api/workspaces/{ws}/goals/{id}

Only the fields given change. status "done" needs evidence (given here or already on the goal).

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).

id*string

The id of what the path names: a hire, a connection, a skill, a shared file, a department, a position, a goal or an approval.

Request Body

application/json
  1. body
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 PATCH 'https://app.useroster.work/api/workspaces/string/goals/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty