/v1/task-templates/{template_id}Authentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request PATCH \
--url 'https://api.staging.facily.ai/v1/task-templates/<TEMPLATE_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"anchor_on": "2026-10-29",
"assignment": {
"mode": "direct",
"user_id": "00000000-0000-4000-8000-000000000001"
},
"cadence": "daily",
"day_of_month": 1,
"description": "string",
"due_offset_days": 0,
"estimated_cost": 0,
"inspection_kind": "string",
"interval_count": 1,
"is_active": false,
"priority": "low",
"requires_photo_proof": false
}'Parameters
template_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
anchor_onstring | nullNew date the schedule counts from. Cannot be cleared.
Format: date
Show anchor_on schema
string | nullNew date the schedule counts from. Cannot be cleared.
Variant 1: string
stringVariant 2: null
nullassignmentTaskAssignmentRequest | nullWho gets each task filed from now on, in the form the create takes. Cannot be cleared: send mode unassigned.
Show assignment schema
TaskAssignmentRequest | nullWho gets each task filed from now on, in the form the create takes. Cannot be cleared: send mode unassigned.
Variant 1: TaskAssignmentRequest
modestringrequireddirect assigns user_id; auto gives the task to the next person in its facility's rotation, and it waits when there is no one; unassigned clears the assignee.
Values: "direct", "auto", "unassigned"
user_idstring | nullThe person to assign, with mode direct only.
Format: uuid
Show user_id schema
string | nullThe person to assign, with mode direct only.
Variant 1: string
stringVariant 2: null
nullVariant 2: null
nullcadencestring | nullNew cadence. The day field the new cadence does not use is cleared, and the one it needs is required. Cannot be cleared.
Values: "daily", "monthly", "weekly"
Show cadence schema
string | nullNew cadence. The day field the new cadence does not use is cleared, and the one it needs is required. Cannot be cleared.
Variant 1: string
stringValues: "daily", "monthly", "weekly"
Variant 2: null
nullday_of_monthinteger | nullNew day of the month of a monthly template, 1 to 31.
Minimum: 1 · Maximum: 31
Show day_of_month schema
integer | nullNew day of the month of a monthly template, 1 to 31.
Variant 1: integer
integerVariant 2: null
nulldescriptionstring | nullNew detail, up to 2,000 characters; explicit null clears it.
Max length: 2000
Show description schema
string | nullNew detail, up to 2,000 characters; explicit null clears it.
Variant 1: string
stringVariant 2: null
nulldue_offset_daysinteger | nullNew number of days after its scheduled day each task falls due. Cannot be cleared.
Minimum: 0 · Maximum: 365
Show due_offset_days schema
integer | nullNew number of days after its scheduled day each task falls due. Cannot be cleared.
Variant 1: integer
integerVariant 2: null
nullestimated_costnumber | string | nullNew estimate of a work order template, as a decimal string: zero or more, at most 99999999.99, with at most two decimal places. Explicit null clears it.
Minimum: 0 · Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show estimated_cost schema
number | string | nullNew estimate of a work order template, as a decimal string: zero or more, at most 99999999.99, with at most two decimal places. Explicit null clears it.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullinspection_kindstring | nullNew kind of round of an inspection template, one of the seven the create takes. Cannot be cleared.
Max length: 30
Show inspection_kind schema
string | nullNew kind of round of an inspection template, one of the seven the create takes. Cannot be cleared.
Variant 1: string
stringVariant 2: null
nullinterval_countinteger | nullNew interval: at most 365 days, 52 weeks or 12 months. Cannot be cleared.
Minimum: 1 · Maximum: 365
Show interval_count schema
integer | nullNew interval: at most 365 days, 52 weeks or 12 months. Cannot be cleared.
Variant 1: integer
integerVariant 2: null
nullis_activeboolean | nullFalse pauses the template, and nothing is filed until it is resumed. True resumes it at its next scheduled day on or after today, without filing the days it missed. Cannot be cleared.
Show is_active schema
boolean | nullFalse pauses the template, and nothing is filed until it is resumed. True resumes it at its next scheduled day on or after today, without filing the days it missed. Cannot be cleared.
Variant 1: boolean
booleanVariant 2: null
nullprioritystring | nullNew priority. Cannot be cleared.
Values: "low", "normal", "high", "urgent"
Show priority schema
string | nullNew priority. Cannot be cleared.
Variant 1: string
stringValues: "low", "normal", "high", "urgent"
Variant 2: null
nullrequires_photo_proofboolean | nullWhether each task filed from now on needs proof photos; explicit null goes back to the facility's default. A change needs the task.manage permission, and turning proof off, or back to a default that is off, needs a person.
Show requires_photo_proof schema
boolean | nullWhether each task filed from now on needs proof photos; explicit null goes back to the facility's default. A change needs the task.manage permission, and turning proof off, or back to a default that is off, needs a person.
Variant 1: boolean
booleanVariant 2: null
nullskip_if_openboolean | nullWhether a scheduled day is skipped while a task this template filed is still open. Cannot be cleared. Turned on, it applies from the next task filed: a task filed while it was off is not found by it, so the next scheduled day may file one more beside it.
Show skip_if_open schema
boolean | nullWhether a scheduled day is skipped while a task this template filed is still open. Cannot be cleared. Turned on, it applies from the next task filed: a task filed while it was off is not found by it, so the next scheduled day may file one more beside it.
Variant 1: boolean
booleanVariant 2: null
nulltitlestring | nullNew title. Cannot be cleared.
Min length: 1 · Max length: 255
Show title schema
string | nullNew title. Cannot be cleared.
Variant 1: string
stringVariant 2: null
nullunit_group_idstring | nullNew unit group of an inspection template: a live unit group of its facility. Explicit null clears it, for the whole facility.
Format: uuid
Show unit_group_id schema
string | nullNew unit group of an inspection template: a live unit group of its facility. Explicit null clears it, for the whole facility.
Variant 1: string
stringVariant 2: null
nullvendorstring | nullNew vendor of a work order template, up to 120 characters; explicit null clears it.
Max length: 120
Show vendor schema
string | nullNew vendor of a work order template, up to 120 characters; explicit null clears it.
Variant 1: string
stringVariant 2: null
nullweekdayinteger | nullNew day of the week of a weekly template, 1 (Monday) to 7 (Sunday).
Minimum: 1 · Maximum: 7
Show weekday schema
integer | nullNew day of the week of a weekly template, 1 (Monday) to 7 (Sunday).
Variant 1: integer
integerVariant 2: null
nullwork_order_categorystring | nullNew trade category of a work order template. Cannot be cleared.
Values: "doors", "electrical", "access", "building", "elevator", "pest_control", "hvac", "security", "paving", "locks", "plumbing", "roofing", "cleaning", "maintenance", "other"
Show work_order_category schema
string | nullNew trade category of a work order template. Cannot be cleared.
Variant 1: string
stringValues: "doors", "electrical", "access", "building", "elevator", "pest_control", "hvac", "security", "paving", "locks", "plumbing", "roofing", "cleaning", "maintenance", "other"
Variant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"anchor_on": "2026-10-29",
"assignee": {
"display_name": "string",
"id": "00000000-0000-4000-8000-000000000001"
},
"assignee_id": "00000000-0000-4000-8000-000000000001",
"assignment_mode": "string",
"cadence": "string",
"capabilities": {
"delete": false,
"edit": false,
"pause": false
},
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"day_of_month": 0,
"description": "string",
"due_offset_days": 0,
"estimated_cost": "<VALUE_MATCHING_PATTERN>",
"facility_id": "00000000-0000-4000-8000-000000000001",
"facility_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"inspection_kind": "string",
"interval_count": 0,
"is_active": false,
"kind": "string",
"last_run_on": "2026-10-29",
"next_run_on": "2026-10-29",
"priority": "string",
"requires_photo_proof": false,
"skip_if_open": false,
"task_type": "string",
"title": "string",
"unit_group_id": "00000000-0000-4000-8000-000000000001",
"updated_at": "2026-10-29T12:00:00Z",
"vendor": "string",
"weekday": 0,
"work_order_category": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataTaskTemplateResponserequiredOne recurring template, with what the caller may do with it.
Show data schema
anchor_onstringrequiredThe date the schedule counts from, in the facility's calendar.
Format: date
assigneePersonResponse | nullrequiredThat person; null when there is none.
Show assignee schema
PersonResponse | nullThat person; null when there is none.
Variant 1: PersonResponse
display_namestringrequiredThe name to show for the user.
idstringrequiredThe user's id.
Format: uuid
Variant 2: null
nullassignee_idstring | nullrequiredThe person a direct template gives each task to; null otherwise.
Format: uuid
Show assignee_id schema
string | nullThe person a direct template gives each task to; null otherwise.
Variant 1: string
stringVariant 2: null
nullassignment_modestringrequireddirect, auto or unassigned: who gets each task filed.
cadencestringrequireddaily, weekly or monthly.
capabilitiesTaskTemplateCapabilitiesResponserequiredWhat the caller may do with a template now, from their permissions at its facility.
Show capabilities schema
deletebooleanrequiredTrue when the caller may delete it now.
editbooleanrequiredTrue when the caller may change the template now.
pausebooleanrequiredTrue when the caller may pause or resume it now.
created_atstringrequiredWhen the template was created.
Format: date-time
created_bystringrequiredWho created it.
Format: uuid
day_of_monthinteger | nullrequiredA monthly template's day of the month, 1 to 31; null otherwise.
Show day_of_month schema
integer | nullA monthly template's day of the month, 1 to 31; null otherwise.
Variant 1: integer
integerVariant 2: null
nulldescriptionstring | nullrequiredLonger detail copied onto each task filed.
Show description schema
string | nullLonger detail copied onto each task filed.
Variant 1: string
stringVariant 2: null
nulldue_offset_daysintegerrequiredHow many days after its scheduled day each task falls due.
estimated_coststring | nullrequiredA work order template's estimate, as a decimal string; null when there is none.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show estimated_cost schema
string | nullA work order template's estimate, as a decimal string; null when there is none.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility the template files at.
Format: uuid
facility_namestringrequiredThat facility's name.
idstringrequiredThe template's id.
Format: uuid
inspection_kindstring | nullrequiredAn inspection template's kind of round; null otherwise.
Show inspection_kind schema
string | nullAn inspection template's kind of round; null otherwise.
Variant 1: string
stringVariant 2: null
nullinterval_countintegerrequiredEvery how many days, weeks or months.
is_activebooleanrequiredFalse while the template is paused.
kindstringrequiredWhat each run files: task, work_order or inspection.
last_run_onstring | nullrequiredThe last scheduled day a run handled; null before the first.
Format: date
Show last_run_on schema
string | nullThe last scheduled day a run handled; null before the first.
Variant 1: string
stringVariant 2: null
nullnext_run_onstringrequiredThe next scheduled day, in the facility's calendar.
Format: date
prioritystringrequiredHow urgent each task filed is.
requires_photo_proofboolean | nullrequiredWhether each task filed needs proof photos. Null: each takes the facility's default for its type on the day it is filed.
Show requires_photo_proof schema
boolean | nullWhether each task filed needs proof photos. Null: each takes the facility's default for its type on the day it is filed.
Variant 1: boolean
booleanVariant 2: null
nullskip_if_openbooleanrequiredTrue skips a scheduled day while a task this template filed is still open.
task_typestringrequiredThe board type of each task filed. A work order or inspection template's is its kind.
titlestringrequiredWhat each task filed is called.
unit_group_idstring | nullrequiredThe unit group an inspection template's rounds cover; null for the whole facility or another kind.
Format: uuid
Show unit_group_id schema
string | nullThe unit group an inspection template's rounds cover; null for the whole facility or another kind.
Variant 1: string
stringVariant 2: null
nullupdated_atstringrequiredWhen it last changed.
Format: date-time
vendorstring | nullrequiredA work order template's vendor; null when there is none.
Show vendor schema
string | nullA work order template's vendor; null when there is none.
Variant 1: string
stringVariant 2: null
nullweekdayinteger | nullrequiredA weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.
Show weekday schema
integer | nullA weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.
Variant 1: integer
integerVariant 2: null
nullwork_order_categorystring | nullrequiredA work order template's trade category; null otherwise.
Show work_order_category schema
string | nullA work order template's trade category; null otherwise.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired