Skip to navigation

Hide or show a component's update notice

View as MarkdownOpen in Claude

Hides or shows the update notice of one plugin, theme or WordPress version on the websites you list in sites. A hidden item is left out of site item listings and totals unless you ask for hidden items, and requests that act on the component skip it. The change is immediate: nothing runs on the websites and their connection is not checked, so there is nothing to follow up.

The answer lists the items that changed. Websites that cannot be processed are reported in meta.skipped, each with a reason_code and a message, and do not fail the call. A website is skipped as NOT_FOUND when the component is not installed on it, as ALREADY_APPLIED when it already has the requested state, and as PERMISSION_DENIED when you have no access to it.

Body

  • sites (array of integers, required): ids of the websites to act on, 1 to 50.
  • is_hidden (boolean, required): true hides the update notice, false shows it again. It sets the state and never flips it.

Errors

  • 404: the component is not installed on any of your websites.
  • 422: sites is invalid, or is_hidden is missing or not a boolean.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

componentstringRequired

Request

This endpoint expects an object.
is_hiddenbooleanOptional
siteslist of doublesOptional

Response

200 - One website hidden, one already hidden

jsonapiobjectOptional
metaobjectOptional