Skip to main content
PATCH
/
v4
/
plans
/
{plan_id}
Update Plan
curl --request PATCH \
  --url https://api.egp.scale.com/v4/plans/{plan_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "associated_file_ids": [
    "<string>"
  ],
  "steps": {},
  "restore": false
}
'
{
  "id": "<string>",
  "title": "<string>",
  "associated_file_ids": [
    "<string>"
  ],
  "steps": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "account_id": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
plan_id
string
required

Body

application/json
​
title
string
​
start_date
string<date-time>

Start of the planning window.

​
end_date
string<date-time>

End of the planning window.

​
associated_file_ids
string[]

Plan-level file/report references.

​
steps
Steps · object

Tree of step -> substep state (threadIds, etc).

​
restore
boolean
default:false

Set to true to restore the entity from the database.

Response

Successful Response

​
id
string
required
​
title
string
required
​
associated_file_ids
string[]
required

Plan-level file/report references.

​
steps
Steps · object
required

Tree of step -> substep state (threadIds, etc).

​
created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

​
updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
​
account_id
string
required

The ID of the account that owns the given entity.

​
start_date
string<date-time>

Start of the planning window.

​
end_date
string<date-time>

End of the planning window.

​
archived_at
string<date-time>

The date and time when the entity was archived in ISO format.