Skip to main content

Update task

PUT 
/v2/actor-tasks/:actorTaskId

Update settings of a task using values specified by an object passed as JSON in the POST payload.

If the object does not define a specific property, its value is not updated.

The response is the full task object as returned by the Get task endpoint.

The request needs to specify the Content-Type: application/json HTTP header!

When providing your API authentication token, we recommend using the request's Authorization header, rather than the URL. (More info).

Request

Path Parameters

    actorTaskId string required

    Task ID or a tilde-separated owner's username and task's name.


    Example: janedoe~my-task

Bodyrequired

  • id string required
    Example: ZxLNxrRaZrSjuhT9y
  • userId string required
    Example: BPWZBd7Z9c746JAnF
  • actId string required
    Example: asADASadYvn4mBZmm
  • name string required
    Example: my-task
  • username string | null nullable
    Example: janedoe
  • createdAt string<date-time> required
    Example: 2018-10-26T07:23:14.855Z
  • modifiedAt string<date-time> required
    Example: 2018-10-26T13:30:49.578Z
  • removedAt string,null<date-time> nullable
  • stats object
      anyOf
    • totalRuns integer
      Example: 15
  • options object
      anyOf
    • build string | null nullable
      Example: latest
    • timeoutSecs integer | null nullable
      Example: 300
    • memoryMbytes integer | null nullable
      Example: 128
    • restartOnError boolean | null nullable
      Example: false
  • input object
      anyOf
    • object

      The input configuration for the Actor task. This is a user-defined JSON object that will be passed to the Actor when the task is run.


      Example: {"startUrls":[{"url":"https://example.com"}],"maxRequestsPerCrawl":100}

Status 200

Response Headers
    {
      "data": {
        "id": "zdc3Pyhyz3m8vjDeM",
        "userId": "wRsJZtadYvn4mBZmm",
        "actId": "asADASadYvn4mBZmm",
        "name": "my-task",
        "username": "janedoe",
        "createdAt": "2018-10-26T07:23:14.855Z",
        "modifiedAt": "2018-10-26T13:30:49.578Z",
        "removedAt": null,
        "stats": {
          "totalRuns": 15
        },
        "options": {
          "build": "latest",
          "timeoutSecs": 300,
          "memoryMbytes": 128
        },
        "input": {
          "hello": "world"
        }
      }
    }