Skip to main content
PATCH
/
v1
/
positions
/
{id}
Update a position
curl --request PATCH \
  --url https://api.plane.com/v1/positions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "status": "<string>",
  "plan": "<string>",
  "location": {},
  "employer": {},
  "starts": "<string>",
  "ends": "<string>",
  "compensation": {},
  "metadata": {}
}
'

​
Parameters

​
id
string
required
ID of the position.
​
name
string
Optional display name for the planned seat.
​
status
string
Position status.
​
plan
string
Workforce plan ID.
​
location
object
Position location.
​
employer
object
Employer model for the position. Supported types are employee and contractor.
​
starts
string
Position start date.
​
ends
string
Position end date.
​
compensation
object
Compensation input for the position.
​
metadata
object
Set of key-value pairs attached to the position.

​
Returns

Returns the updated Position object.