Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

One-Off Tasks

Update a one-off task

Updates a one-off task. PUT semantics: all fields must be provided. Returns the updated task.

put/work/tasks/{taskId}

Path parameters

taskIdstring required

The ID of the One-Off Task

Request body

namestring required

Display name.

descriptionstring

Optional long-form description.

dueDatestring date-time

Due date. ISO-8601 UTC.

requiredboolean required

When true, the form field must have a value before its task can be completed.

linkedWorkflowRunIdstring
assigneeEmailsstring[]

Response

Example response

{
  "data": {
    "id": "mlbxbYW5BxoKZyuz0GtEhg",
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "assignments": [
      {
        "user": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      }
    ],
    "linkedWorkflowRun": {
      "id": "hhY3-a3YNHpYViPMvqJOCQ",
      "templateId": "hhY3-a3YNHpYViPMvqJOCQ"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}