Skip to main content

Display Actor status

You can display an Actor status badge and a custom message on your Actor's page in Apify Store. Use this option to keep your users informed about the current status of the Actor development process.

Access status options

To access the available status options for an Actor:

  1. Log in to Apify Console.
  2. In the left-side panel, go to Development > My Actors.
  3. From the table, select the Actor whose status you want to update.
  4. Go to the Publication tab.
  5. Expand the Display information section.

Add custom status

To let your Actor users know about ongoing work, use the custom status. For example, you can inform users about fixing an issue or developing a new feature.

To add a custom status to your Actor:

  1. In Actor status section, switch on the Custom status toggle.
  2. Complete the following fields:
    • Title – the status message, for example A new version coming soon.
    • Description – additional explanation of the status in a form of a tooltip. This field is optional.
  3. Select Save.

Mark Actor as under maintenance

To let users know that the Actor might temporarily not work as expected, use the Under maintenance status:

  1. In Actor status section, switch on the Under maintenance toggle.
  2. (Optional) In the Under maintenance message field, add an additional explanation.
  3. Select Save.

Note that the Under maintenance status makes your Actor rank lower in search results. It's also automatically set when your Actor fails the automated testing process.

Mark Actor as deprecated

To let your users know that the Actor is no longer being developed, use the Deprecated status:

  1. In Actor status section, switch on the Deprecated toggle.
  2. (Optional) In the Deprecated message field, add an additional explanation.
  3. Select Save.

Don't delete the Actor as it might break the existing integrations.

Note that the deprecated Actors aren't searchable in Apify Store. The Deprecated status is also automatically set when your Actor fails the automated testing process for 30 days.