API

Update a maintenance plan

put
https://api.safetyculture.io/assets/v1/maintenance/plan/

Update specific attributes of a maintenance plan using the update_mask parameter to control which properties are modified.

  • If update_mask=name, only the name is updated regardless of other values in the request body.
  • If update_mask=description, only the description is updated.
  • If update_mask=interval, the maintenance interval is updated.
  • If update_mask=due_soon, the due-soon threshold is updated. The due-soon value must not exceed the interval.
  • If update_mask=notifications, the notification actions are updated.
  • Multiple attributes can be updated in one request using comma-separated values: update_mask=name,description,interval.
  • Any attributes not listed in update_mask are ignored, even if present in the request body. Invalid paths return an error.

Requirements

Path Params
string
required

The identifier of the maintenance plan.

Body Params

The parameters for UpdatePlan

plan
object

MaintenancePlan which replaces the one with matching identifier on the server.

string
required

REQUIRED. The attributes (such as name, etc.) you
want to update for the plan, specified in the parameters. For example, the
update_mask=name parameter indicates that only the name will be
updated in a request, any other attributes provided in your request body
will be ignored.

Responses

Updated 2 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago