Corrigo: Update (Update Command)

← Commands operations · Get started

Operation corrigo.cmd_updatecommand

Provider route: POST /v1/cmd/UpdateCommand. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { CorrigoIntegration } from "@alter-ai/corrigo";

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

import os
from alter_sdk import App
from alter_sdk_corrigo import CorrigoIntegration

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Additional keys: not allowed
body.requestId	JSON	Optional
body.requestId (anyOf 1)	string	Alternative
body.requestId (anyOf 2)	null	Alternative
body.command	Model	Required within parent	Expand Update (Update Command) — request body — body command

Referenced models: Update (Update Command) — request body — body command

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
$	JSON	Root

Schemas

Update (Update Command) — request body — body command

Field	Type	Presence	Description and constraints
$	object	Root
entity	JSON	Optional
entity (anyOf 1)	object	Alternative	A Corrigo CorrigoEntity.
entity (anyOf 2)	null	Alternative
propertySet	JSON	Optional
propertySet (anyOf 1)	object	Alternative	A Corrigo PropertySetBase.
propertySet (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: corrigo.cmd_updatecommand. Catalog operation: cmd.UpdateCommand. 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.

Refused by default. This operation leaves the caller holding a credential (Refused by default: the entity it names can be an Employee, so it can set Password, a login password the caller would then know. An admin allows it with a credential_minting rule, outright or behind approval.), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider corrigo and operation corrigo.cmd_updatecommand (or cmd.UpdateCommand). See Allow an operation that hands over a credential.

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