Apply a template to an existing task.
const url = 'https://api-us.suiteop.com/api/v1/task-template-applications';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"replace":true,"taskId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","templateId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api-us.suiteop.com/api/v1/task-template-applications \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "replace": true, "taskId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Apply a task template’s requirements onto an EXISTING task. Use for ‘add the Deep Clean requirements to this task’, ‘attach the Maintenance Inspection template’. Pass replace: true to swap out the current requirements (and any prior template binding) — destructive; only when the operator explicitly asks to switch templates. Without replace, the call is rejected on tasks that already have a template attached.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
Example generated
{ "replace": true, "taskId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”Created successfully.
object
Response payload.
object
Response metadata present on every success response.
object
Present on list responses.
object
Page size used for this request.
Number of items skipped.
Total number of matching items (across all pages).
Unique identifier for this request.
Example generated
{ "data": { "itemCount": 1, "taskItemIds": [ "example" ] }, "meta": { "pagination": { "limit": 1, "offset": 1, "total": 1 }, "requestId": "example" }}Headers
Section titled “Headers ”Present with value ‘true’ only when this response was replayed from a previously stored Idempotency-Key result.
Maximum requests per minute for this API key.
Remaining requests in the current rate-limit window.
Unix epoch seconds when the rate-limit window resets.
Unique identifier for this request (matches meta.requestId in the body).
400
Error envelope returned for HTTP 400 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "validation_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
401
Error envelope returned for HTTP 401 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "authentication_error" }}Headers
Section titled “Headers ”Request correlation id (also in meta.requestId).
403
Error envelope returned for HTTP 403 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "authorization_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
404
Error envelope returned for HTTP 404 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "not_found_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
409
Error envelope returned for HTTP 409 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "conflict_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
422
Error envelope returned for HTTP 422 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "business_rule_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
429
Error envelope returned for HTTP 429 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "rate_limit_error" }}Headers
Section titled “Headers ”Number of seconds to wait before retrying.
Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).
500
Error envelope returned for HTTP 500 responses.
object
object
Machine-readable error code.
Optional structured details (omitted when undefined).
object
Human-readable error message.
Error type.
object
Example
{ "error": { "type": "internal_error" }}Headers
Section titled “Headers ”Maximum requests per minute.
Remaining requests in the current window.
Unix epoch seconds when the window resets.
Request correlation id (also in meta.requestId).