Mark an assignment as started, moving it to in_progress.

POSThttps://app.softsolz.uk/api/v1/services/tasks/assignments/{id}/start

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Response

Response Body

idintegerAssignment id.

task_idintegerParent task id.

assignee_user_idintegerWho has to do the work.

assigned_byinteger | nullWho handed it out.

group_idinteger | nullThe group this assignment came through, if any.

delegated_byinteger | nullSet when a previous assignee passed their own work on, which is different from being assigned it.

delegation_reasonstring | nullWhy it was delegated.

statusstringWhere this person is in the loop.

due_atstring | nullEffective deadline for this person.

original_due_atstring | nullThe deadline first set. Never overwritten, so slippage is always measurable.

checklist_statearray of objectsPer-step progress: { id, checked_at, checked_by, note, file_keys }.

custom_fieldsobjectValues for workspace-defined fields scoped to the assignment.

scorenumber | nullRaw number from the latest review. Presentation is derived from the grading scheme.

attempt_countintegerSubmissions made so far.

started_atstring | nullWhen work began.

submitted_atstring | nullLatest submission time.

completed_atstring | nullWhen approved.

reopened_atstring | nullWhen last reopened.

updated_atstringLast change.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.tasks.createAssignmentStart('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": 0,
    "task_id": 0,
    "assignee_user_id": 0,
    "assigned_by": 0,
    "group_id": 0,
    "delegated_by": 0,
    "delegation_reason": "string",
    "status": "string",
    "due_at": "string",
    "original_due_at": "string",
    "checklist_state": [],
    "custom_fields": {},
    "score": "string",
    "attempt_count": 0,
    "started_at": "string",
    "submitted_at": "string",
    "completed_at": "string",
    "reopened_at": "string",
    "updated_at": "string"
  }
}