Skip to content

Ramp: Add an approver to an approval instance

Ramp approvals.postAddToApprovalInstanceResource: arguments, response, policy and SDK examples.

← Approvals operations · Get started

Operation ramp.post_add_to_approval_instance_resource

Provider route: POST /developer/v1/approvals/{entity_type}/{entity_id}/add-step. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["approvals"]["postAddToApprovalInstanceResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.approvals.postAddToApprovalInstanceResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.approvals.post_add_to_approval_instance_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.entity_typestringRequired within parentOne of: bill, reimbursement, transaction
path.entity_idstringRequired within parent
bodyModelRequired within parentExpand Add an approver to an approval instance — request body — body

Referenced models: Add an approver to an approval instance — request body — body

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

FieldTypePresenceDescription and constraints
$nullRoot
Add an approver to an approval instance — request body — body
FieldTypePresenceDescription and constraints
$objectRootAn approval step to add to an existing approval chain.
approver_groupsarrayRequired within parentApprover groups included in the step.
Minimum items: 1
approver_groups[]ModelEach itemExpand Add an approver to an approval instance — request body — body approver groups item
reasonstringRequired within parentReason for adding the approval step.
step_orderintegerOptionalPosition of the step in the approval chain.
Minimum: 1
step_typestringRequired within parentApproval behavior for the step.
One of: REQUIRE_ALL, REQUIRE_ANY

Referenced models: Add an approver to an approval instance — request body — body approver groups item

Add an approver to an approval instance — request body — body approver groups item
FieldTypePresenceDescription and constraints
$objectRootA group of users to add to an approval step.
typestringRequired within parentType of approver group.
One of: USER
usersarrayRequired within parentUsers included in the approver group.
Minimum items: 1
users[]ModelEach itemExpand Add an approver to an approval instance — request body — body approver groups item users item

Referenced models: Add an approver to an approval instance — request body — body approver groups item users item

Add an approver to an approval instance — request body — body approver groups item users item
FieldTypePresenceDescription and constraints
$objectRootA user to add as an approver.
emailstringOptionalEmail address of the approver.
Format: email
idstringOptionalUnique identifier of the approver.
Format: uuid

SDK function policy ID: ramp.post_add_to_approval_instance_resource. Catalog operation: post_add_to_approval_instance_resource. 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.

Required provider scopes: ["approval_chains:write"]

No-content response statuses: [204]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.