Update task

Update a task

put

Update a task. Only the owner service or extension can update a task. Use this endpoint to update progress, ETA, and parameters.

Path parameters

idstringRequired

The task ID.

Body

application/jsontext/jsonapplication/*+json

The Task represents the state of an asynchronous, usually long running operation.

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

codestringOptional

Task code for the workflow, prefixed with the service namespace.

Example: platform.accounts.buyers.transfer

queuestringOptional

Queue name for task execution, prefixed with the controlling service namespace.

Example: marketplace/platform/internal/buyers/commands

descriptionstringOptional

Parameterized task description.

Example: Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'

progressnumber · float · nullableOptional

Progress in percent. 0-100 or not defined for not yet started task.

Example: 45.5

etastring · date-time · nullableOptional

Estimated finish time, if any.

Example: 2026-02-02T14:30:00+00:00

parametersany · nullableOptional

Optional parameters to store task-specific metadata.

Example: {"BuyerId":"BUY-1190-0394","TargetAccountId":"ACC-5563-4382"}

resultstring · nullableOptional

Result URI or reference to the result resource.

Example: /public/v1/accounts/buyers/BUY-1190-0394

externalIdstring · nullableOptional

External identifier for task correlation.

Example: 3f7e7800-b929-4bf3-a969-a8ed5354ff27

Responses

200

OK

application/json

The Task represents the state of an asynchronous, usually long running operation.

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

statusstring · enumOptionalPossible values:

codestringOptional

Task code for the workflow, prefixed with the service namespace.

Example: platform.accounts.buyers.transfer

queuestringOptional

Queue name for task execution, prefixed with the controlling service namespace.

Example: marketplace/platform/internal/buyers/commands

descriptionstringOptional

Parameterized task description.

Example: Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'

progressnumber · float · nullableOptional

Progress in percent. 0-100 or not defined for not yet started task.

Example: 45.5

etastring · date-time · nullableOptional

Estimated finish time, if any.

Example: 2026-02-02T14:30:00+00:00

parametersany · nullableOptional

Optional parameters to store task-specific metadata.

Example: {"BuyerId":"BUY-1190-0394","TargetAccountId":"ACC-5563-4382"}

resultstring · nullableOptional

Result URI or reference to the result resource.

Example: /public/v1/accounts/buyers/BUY-1190-0394

externalIdstring · nullableOptional

External identifier for task correlation.

Example: 3f7e7800-b929-4bf3-a969-a8ed5354ff27

put/public/v1/system/tasks/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/system/tasks/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "progress": 45.5,
  "eta": "2026-02-02T14:30:00+00:00",
  "parameters": {
    "Step": "transfer"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "id": "TSK-0001-2474-4798-1266",
  "name": "Transferring the buyer to a different account",
  "revision": 5,
  "status": "Processing",
  "code": "accounts.buyers.transfer",
  "queue": "marketplace/platform/internal/buyers/commands",
  "object": {
    "id": "BUY-1190-0394"
  },
  "description": "Transferring buyer 'BUY-1190-0394' to account 'ACC-5563-4382'",
  "progress": 45.5,
  "eta": "2026-02-02T14:30:00+00:00",
  "parameters": {
    "BuyerId": "BUY-1190-0394",
    "TargetAccountId": "ACC-5563-4382",
    "Step": "transfer"
  },
  "owner": {
    "id": "SVC-0001",
    "name": "platform"
  },
  "audit": {
    "created": {
      "at": "2026-02-02T12:00:00+00:00",
      "by": {
        "id": "SVC-0001",
        "name": "Platform"
      }
    },
    "updated": {
      "at": "2026-02-02T13:00:00+00:00",
      "by": {
        "id": "SVC-0001",
        "name": "Platform"
      }
    }
  }
}