Skip to content
Docs

Change a position

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

Only the fields given change; null clears one. Giving a holder replaces the old one.

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 <= 120
departmentId?|
Defaultnull
managerPositionId?|
Defaultnull
leadsDepartment?boolean
Defaultfalse
hireId?|
Defaultnull
userId?|
Defaultnull
chat?|
Defaultnull
goalMode?string
Default"manager_sets"
Value in"manager_sets""report_proposes""report_sets"
monthlyHours?|
Defaultnull

Response Body

The position.

Example Request
curl -X PATCH 'https://app.useroster.work/api/workspaces/string/positions/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Add a position POST

A holder is a hire (`hireId`), a person (`userId` and/or `chat`), or nobody. 400 for a circle of managers, a second lead in a department, a hire already in a position, or a holder that is both a hire and a person.

Remove a position DELETE

Next Page