Sign in
Tasks

Update a task

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

patch/v1/tasks/{taskId}

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

department'none' | 'admin' | 'gov' | 'hr' | 'it' | 'itsm' | 'qms'
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

Changed in 3 of the 51 revisions of this API.16

  • 4c7c42b20b901See the full diff
    • ○

      added the new optional request property notRelevantJustification

      new-optional-request-property

  • 36253e8a5c1b3See the full diff
    • ○

      added the new optional request property integrationScheduleFrequency

      new-optional-request-property

    • ○

      added the optional property integrationLastRunAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property integrationScheduleFrequency to the response with the 200 status

      response-required-property-added

  • 946edaa856a912See the full diff
    • ●

      deleted the header request parameter X-Organization-Id

      request-parameter-removed

    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

      added the new optional request property title

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog