Ramp: Upload documents for a vendor agreement

← vendor operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation ramp.post_vendor_agreement_document_upload_resource

Provider route: POST /developer/v1/vendors/agreements/{agreement_id}/documents. Alter supplies the connection’s credentials and routing.

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["vendor"]["postVendorAgreementDocumentUploadResource"]>[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.vendor.postVendorAgreementDocumentUploadResource(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.vendor.post_vendor_agreement_document_upload_resource(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.agreement_id	string	Required within parent
headers	object	Required within parent	Additional keys: not allowed
headers.X-Idempotency-Key	string	Required within parent	Maximum length: 255 Minimum length: 1
body	object	Required within parent
body.documents	array	Optional	Agreement documents to upload.
body.documents[]	object	Each item	Additional keys: not allowed
body.documents[].filename	string	Required within parent	Minimum length: 1
body.documents[].content_type	string	Required within parent	Minimum length: 1
body.documents[].content_base64	string	Required within parent

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 Upload documents for a vendor agreement — response body

Referenced models: Upload documents for a vendor agreement — response body

Policy, approvals and errors

SDK function policy ID: ramp.post_vendor_agreement_document_upload_resource. Catalog operation: post_vendor_agreement_document_upload_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: ["vendors:write"]

Official provider source