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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.entity_type | string | Required within parent | One of: bill, reimbursement, transaction |
path.entity_id | string | Required within parent | |
body | Model | Required within parent | Expand Add an approver to an approval instance — request body — body |
Referenced models: Add an approver to an approval instance — request body — body
Response
Section titled “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 |
|---|---|---|---|
$ | null | Root |
Schemas
Section titled “Schemas”Add an approver to an approval instance — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An approval step to add to an existing approval chain. |
approver_groups | array | Required within parent | Approver groups included in the step. Minimum items: 1 |
approver_groups[] | Model | Each item | Expand Add an approver to an approval instance — request body — body approver groups item |
reason | string | Required within parent | Reason for adding the approval step. |
step_order | integer | Optional | Position of the step in the approval chain. Minimum: 1 |
step_type | string | Required within parent | Approval 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A group of users to add to an approval step. |
type | string | Required within parent | Type of approver group. One of: USER |
users | array | Required within parent | Users included in the approver group. Minimum items: 1 |
users[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user to add as an approver. |
email | string | Optional | Email address of the approver. Format: email |
id | string | Optional | Unique identifier of the approver. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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]