TRtrycompai
Tasks

Update a task

Changed on

Update a task in Comp AI. Manage compliance task lifecycle, assignments, review approvals, evidence uploads, policy links, and activity history.

patch/v1/tasks/{taskId}

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Path parameters

taskIdstring required
Example:tsk_abc123def456

Unique task identifier

Request body

titlestring

Task title

descriptionstring

Task description

status'todo' | 'in_progress' | 'in_review' | 'done' | 'not_relevant' | 'failed'
assigneeIdstring nullable

Assignee member ID, or null to unassign

approverIdstring nullable

Approver member ID, or null to unassign

frequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'
integrationScheduleFrequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'

Cadence for running the integration check attached to this task

departmentstring

Built-in values: none, admin, gov, hr, it, itsm, qms. Custom department names are also accepted.

reviewDatestring date-time
notRelevantJustificationstring

Required justification when marking evidence tasks as not_relevant

Example request

{
  "title": "Review access controls",
  "description": "Review and update access control policies",
  "status": "in_progress",
  "assigneeId": "mem_abc123",
  "approverId": "mem_abc123",
  "frequency": "monthly",
  "integrationScheduleFrequency": "daily",
  "department": "it",
  "reviewDate": "2025-01-01T00:00:00.000Z",
  "notRelevantJustification": "This control is out of scope for our SOC 2 audit."
}

Response

Task updated successfully

idstring required

Unique identifier for the task

titlestring required

Task title

descriptionstring

Task description

status'todo' | 'in_progress' | 'done' | 'blocked' required

Task status

createdAtstring date-time required

Task creation timestamp

updatedAtstring date-time required

Task last update timestamp

taskTemplateIdobject nullable

Task template ID

integrationScheduleFrequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required

Cadence for running the integration check attached to this task

integrationLastRunAtobject nullable

Last successful integration check run timestamp

Example response

{
  "id": "tsk_abc123def456",
  "title": "Implement user authentication",
  "description": "Add OAuth 2.0 authentication to the platform",
  "status": "in_progress",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "integrationScheduleFrequency": "daily"
}

Changes

  • 33c685841b7aRevision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value gov of the request property

    • breaking

      removed the enum value hr of the request property

    • breaking

      removed the enum value it of the request property

    • breaking

      removed the enum value itsm of the request property

    • breaking

      removed the enum value none of the request property

    • breaking

      removed the enum value qms of the request property

    • warning

      the request property's maxLength was set to 64

  • 7ca7c363a732Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new admin enum value to the request property

    • info

      added the new gov enum value to the request property

    • info

      added the new hr enum value to the request property

    • info

      added the new it enum value to the request property

    • info

      added the new itsm enum value to the request property

    • info

      added the new none enum value to the request property

    • info

      added the new qms enum value to the request property