Skip to main content
POST
Change a plan's own details, leaving its scope, triggers and tasks alone.

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

Change a plan's own details, leaving its scope, triggers and tasks alone.

Three of its arguments are about who does the work and they are not interchangeable. assigned_team_id and preferred_worker_id are in-house, and generation prefers the crew of the two; preferred_vendor_id is the route out, taken only when neither in-house slot is filled. assigned_to_user_id is none of those — it is the login the schedule's reminders go to.

NULL on any of them means leave it alone, so each has a clear flag beside it: a leaver comes off two hundred plans, and a contract ending brings work back in-house.

On an active plan that raises its own work, the rounds inside the lead time are made due and their work is raised before this returns, rather than by the next scheduled sweep.

p_plan_id
string<uuid>
required
p_assigned_team_id
string<uuid>
p_assigned_to_user_id
string<uuid>
p_auto_generate_work_order
boolean<boolean>
p_clear_assigned_team
boolean<boolean>
p_clear_assigned_to_user
boolean<boolean>
p_clear_end_date
boolean<boolean>
p_clear_inspection_template
boolean<boolean>
p_clear_preferred_vendor
boolean<boolean>
p_clear_preferred_worker
boolean<boolean>
p_clear_reminder_days
boolean<boolean>
p_description
string<text>
p_end_date
string<date>
p_estimated_duration_minutes
integer<integer>
p_inspection_template_id
string<uuid>
p_instructions
string<text>
p_lead_time_days
integer<integer>
p_maintenance_type
string<text>
p_name
string<text>
p_preferred_vendor_id
string<uuid>
p_preferred_worker_id
string<uuid>
p_priority_code
string<text>
p_reminder_days
integer<integer>
p_requires_permit
boolean<boolean>
p_requires_shutdown
boolean<boolean>
p_safety_instructions
string<text>
p_site_id
string<uuid>
p_sla_resolution_minutes
integer<integer>
p_sla_response_minutes
integer<integer>
p_tolerance_days
integer<integer>
p_trigger_combination
string<text>
p_use_contract_visits
boolean<boolean>

Response

200

OK