Skip to main content
PATCH
/
plans
/
v1
/
rs
/
{planId}
Update an plan by its ID
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/plans/v1/rs/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "name": "Main Plan",
  "documentId": 1,
  "siteId": 1
}
'
{
  "data": {
    "id": 1,
    "name": "Main Plan",
    "code": "main-plan",
    "buildingId": 1,
    "updatedAt": "2024-12-05T14:56:23.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
planId
integer
required

Unique identifier of the plan.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Body

application/json

Details required to update an plan

​
name
string

Name of the plan.

Maximum string length: 255
Example:

"Main Plan"

​
documentId
integer

Unique identifier of the document.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
siteId
integer | null

Unique identifier of the site.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Response

200 - application/json

The plan was successfully updated

​
data
object
required