Sign in
Framework Editor Task Templates

Update framework editor task template

Update a framework editor task template by ID

patch/v1/framework-editor/task-template/{id}

Path parameters

idstring required
Example:frk_tt_abc123def456

Framework editor task template ID

Request body

namestring

Task template name

descriptionstring

Detailed description of the task template

frequency'monthly' | 'quarterly' | 'yearly'

Frequency of the task

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms'

Department responsible for the task

automationStatus'AUTOMATED' | 'MANUAL'

Automation status of the task

Example request

{
  "name": "Monthly Security Review",
  "description": "Review and update security policies on a monthly basis",
  "frequency": "monthly",
  "department": "it",
  "automationStatus": "AUTOMATED"
}

Response

Successfully updated framework editor task template

{"stackTrail":"paths:/v1/framework-editor/task-template/{id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"id":"frk_tt_abc123def456","name":"Monthly Security Review (Updated)","description":"Review and update security policies on a monthly basis","frequency":"monthly","department":"it","createdAt":"2025-01-01T00:00:00.000Z","updatedAt":"2025-01-02T00:00:00.000Z","authType":"session","authenticatedUser":{"id":"user_123","email":"user@example.com"}}}

Example response

{
  "id": "frk_tt_abc123def456",
  "name": "Monthly Security Review (Updated)",
  "description": "Review and update security policies on a monthly basis",
  "frequency": "monthly",
  "department": "it",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-02T00:00:00.000Z",
  "authType": "session",
  "authenticatedUser": {
    "id": "user_123",
    "email": "user@example.com"
  }
}

Changes