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

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

​
id
string
required
ID of the workforce plan.
​
name
string
Human-readable plan name.
​
status
string
Current plan status. Generic updates cannot approve a draft plan.
​
starts
string
Start date for the planning window.
​
ends
string
End date for the planning window.
​
currency
string
Three-letter ISO currency code used for calculation rollups.
​
metadata
object
Set of key-value pairs attached to the plan.

​
Returns

Returns the updated Workforce plan object.