Sign in
latestOpenAPI 3.1.2Apache 2.02026-08-14231239981.3 KB

186271294840

Actor tasks

Update task

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 publicConfig field carries the display configuration of the task's public landing page, and isPublic publishes or unpublishes the task itself. Both require write permission to the task's Actor.

To publish a task, its Actor must be public, publicConfig.inputSchemaFields and publicConfig.datasetView must be set, and the Actor must have fewer than 50 published tasks. If the task isn't ready to be published, the whole update fails and none of it is applied.

Publishing lists the task among the Actor's examples and makes its input public, so anyone can view and copy it. The landing page itself is shown only while publicConfig still validates against the Actor's current build, so a new build can stop the page from being offered while the task stays published and copyable.

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.

put/v2/actor-tasks/{actorTaskId}

Path parameters

actorTaskIdstring required
Example:janedoe~my-task

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

Request body

namestring
inputTaskInput

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.

titlestring nullable
isPublicboolean

Set to true to publish the task on its public landing page, or false to unpublish it. Sending the value the task already has does nothing.

Example request

{
  "name": "my-task",
  "options": {
    "build": "latest",
    "timeoutSecs": 300,
    "memoryMbytes": 1024,
    "maxItems": 1000,
    "maxTotalChargeUsd": 5
  },
  "input": {
    "startUrls": [
      {
        "url": "https://example.com"
      }
    ],
    "maxRequestsPerCrawl": 100
  },
  "publicConfig": {
    "publishedAt": "2025-06-16T09:20:45.777Z",
    "seoTitle": "Scrape data from a website"
  },
  "isPublic": true
}

Response

Example response

{
  "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",
    "stats": {
      "totalRuns": 15
    },
    "options": {
      "build": "latest",
      "timeoutSecs": 300,
      "memoryMbytes": 1024,
      "maxItems": 1000,
      "maxTotalChargeUsd": 5
    },
    "input": {
      "startUrls": [
        {
          "url": "https://example.com"
        }
      ],
      "maxRequestsPerCrawl": 100
    },
    "publicConfig": {
      "publishedAt": "2025-06-16T09:20:45.777Z",
      "seoTitle": "Scrape data from a website"
    }
  }
}