Skyvern: Rename tag value

← Tags operations · Get started

Operation skyvern.rename_tag_value_v1_tag_values_key_rename_patch

Provider route: PATCH /v1/tag-values/{key}/rename. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["tags"]["renameTagValue"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.tags.renameTagValue(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.tags.rename_tag_value(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.key	string	Required within parent	Tag key (group)
body	Model	Required within parent	Expand Rename tag value — request body — body

Referenced models: Rename tag value — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Rename tag value — response body

Referenced models: Rename tag value — response body

Schemas

Rename tag value — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for ``PATCH /v1/tag-values/{key}/rename``: the renamed label with its carried-over color and the number of workflows re-tagged.
color	string	Required within parent
key	string	Required within parent
renamed_workflow_count	JSON	Required within parent
renamed_workflow_count (anyOf 1)	integer	Alternative
renamed_workflow_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent

Rename tag value — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Body for ``PATCH /v1/tag-values/{key}/rename``. Both the current and the new value ride in the body so values containing ``/`` stay addressable.
new_value	string	Required within parent	New tag value (label) to rename it to.
value	string	Required within parent	Current tag value (label) under the key to rename.

Policy, approvals and errors

SDK function policy ID: skyvern.rename_tag_value_v1_tag_values_key_rename_patch. Catalog operation: rename_tag_value_v1_tag_values__key__rename_patch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source