APapify
Actor tasks

Update Actor task

Changed on

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 and both publicConfig.inputSchemaFields and publicConfig.datasetView must be set. Note that an Actor can have up to 10 published tasks and your account up to 100. If the task doesn't meet all these conditions, the request fails and no fields are updated, including those unrelated to publishing.

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 Actor 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}

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

actorTaskIdstring required
Example:janedoe~my-task

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

Request body

namestring
titlestring nullable
descriptionstring 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,
    "isMaxTotalChargeUsdSetByUser": true,
    "forcePermissionLevel": "LIMITED_PERMISSIONS"
  },
  "input": {
    "startUrls": [
      {
        "url": "https://example.com"
      }
    ],
    "maxRequestsPerCrawl": 100
  },
  "actorStandby": {
    "tenancy": "SINGLE_TENANT"
  },
  "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",
    "nameLowerCase": "my-task",
    "username": "janedoe",
    "createdAt": "2018-10-26T07:23:14.855Z",
    "modifiedAt": "2018-10-26T13:30:49.578Z",
    "stats": {
      "totalRuns": 15,
      "lastRunStartedAt": "2019-11-30T07:34:24.202Z"
    },
    "options": {
      "build": "latest",
      "timeoutSecs": 300,
      "memoryMbytes": 1024,
      "maxItems": 1000,
      "maxTotalChargeUsd": 5,
      "isMaxTotalChargeUsdSetByUser": true,
      "forcePermissionLevel": "LIMITED_PERMISSIONS"
    },
    "input": {
      "startUrls": [
        {
          "url": "https://example.com"
        }
      ],
      "maxRequestsPerCrawl": 100
    },
    "actorStandby": {
      "tenancy": "SINGLE_TENANT"
    },
    "publicConfig": {
      "publishedAt": "2025-06-16T09:20:45.777Z",
      "seoTitle": "Scrape data from a website"
    }
  }
}

Changes

  • 68d2d102e6a2Revision changes
    • breaking

      request property // was restricted to a list of enum values

    • warning

      added the new MULTI_TENANT enum value to the /// response property for the response status

    • warning

      added the new SINGLE_TENANT enum value to the /// response property for the response status

    • warning

      added the new undefined enum value to the /// response property for the response status

    • info

      added the new MULTI_TENANT enum value to the request property //

    • info

      added the new SINGLE_TENANT enum value to the request property //

    • info

      added the new undefined enum value to the request property //

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status