Skip to content

Ramp: Update a vendor agreement

Ramp vendor.patchVendorAgreementResource: arguments, response, policy and SDK examples.

← Vendor operations · Get started

Operation ramp.patch_vendor_agreement_resource

Provider route: PATCH /developer/v1/vendors/agreements/{agreement_id}. 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["vendor"]["patchVendorAgreementResource"]>[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.patchVendorAgreementResource(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.patch_vendor_agreement_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.agreement_idstringRequired within parent
bodyModelRequired within parentExpand Update a vendor agreement — request body — body

Referenced models: Update a vendor agreement — 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
$ModelRootExpand Fetch a vendor agreement — response body

Referenced models: Fetch a vendor agreement — response body

60 more schemas are linked from the tables above, on the schema pages.

Update a vendor agreement — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
auto_renewalbooleanOptionalWhether the agreement automatically renews.
contract_owner_idsarrayOptionalList of contract owner user IDs.
contract_owner_ids[]stringEach itemFormat: uuid
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the vendor agreement.
description (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEnd date of the agreement.
Format: date
end_date (anyOf 2)nullAlternative
last_date_to_terminateJSONOptional
last_date_to_terminate (anyOf 1)stringAlternativeLast date by which the agreement can be terminated.
Format: date
last_date_to_terminate (anyOf 2)nullAlternative
namestringOptionalName of the vendor agreement.
Minimum length: 1
notifications_onbooleanOptionalWhether notifications are enabled for this agreement.
renewal_actionModelOptionalExpand Update a vendor agreement — request body — body renewal action
Renewal action update payload. Supported types are ACTIVE, RENEWED, and CANCELLED.
Schema name: ApiVendorAgreementRenewalActionInput
renewal_notification_settingsJSONOptional
renewal_notification_settings (anyOf 1)ModelAlternativeExpand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers
Notification settings to apply to this agreement.
renewal_notification_settings (anyOf 2)nullAlternative
renewal_notification_snoozeJSONOptional
renewal_notification_snooze (anyOf 1)ModelAlternativeExpand Update a vendor agreement — request body — body renewal notification snooze value
Renewal notification snooze configuration. Deprecated: use renewal_notification_snoozed_until.
Schema name: ApiVendorAgreementRenewalNotificationSnoozeInput
renewal_notification_snooze (anyOf 2)nullAlternative
renewal_notification_snoozed_untilJSONOptional
renewal_notification_snoozed_until (anyOf 1)stringAlternativeDate when renewal reminders resume. Must be after today and at most one year from today
Date when renewal reminders resume. Must be after today and at most one year from today. Null ends an active snooze.
Format: date
Schema name: ApiVendorAgreementRenewalNotificationSnoozeDate
renewal_notification_snoozed_until (anyOf 2)nullAlternative
start_datestringOptionalStart date of the agreement.
Format: date
total_valueModelOptionalExpand Create a vendor agreement — request body — body total value
Total monetary value of the agreement.

Referenced models: Create a vendor agreement — request body — body total value, Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers, Update a vendor agreement — request body — body renewal action, Update a vendor agreement — request body — body renewal notification snooze value

Create a vendor agreement — request body — body total value
FieldTypePresenceDescription and constraints
$objectRoot
amountintegerRequired within parentMonetary amount in the currency's minor unit.
currency_codeModelOptionalExpand Edit a procurement request — request body — body currency
Three-letter ISO currency code for the amount.
Default: USD

Referenced models: Edit a procurement request — request body — body currency

Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers
FieldTypePresenceDescription and constraints
$objectRootComplete notification configuration used by create, merge, and the developer API.

Omitted or null fields take their empty/false defaults; omitted or null
``recurring_settings`` disables recurrence. Omitted or null
``scheduled_enabled`` keeps the replaced group's value (true for new groups).
notification_triggersJSONOptional
notification_triggers (anyOf 1)arrayAlternativeDefault: null
notification_triggers (anyOf 1)[]ModelEach itemExpand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers notification triggers array item
notification_triggers (anyOf 2)nullAlternative
recipient_approval_group_uuidsJSONOptional
recipient_approval_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_approval_group_uuids (anyOf 1)[]stringEach item
recipient_approval_group_uuids (anyOf 2)nullAlternative
recipient_dynamic_user_group_uuidsJSONOptional
recipient_dynamic_user_group_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_dynamic_user_group_uuids (anyOf 1)[]stringEach item
recipient_dynamic_user_group_uuids (anyOf 2)nullAlternative
recipient_user_uuidsJSONOptional
recipient_user_uuids (anyOf 1)arrayAlternativeDefault: null
recipient_user_uuids (anyOf 1)[]stringEach item
recipient_user_uuids (anyOf 2)nullAlternative
recurring_settingsJSONOptional
recurring_settings (anyOf 1)ModelAlternativeExpand Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers recurring settings Complete recurring reminder configuration
Complete recurring configuration; omission or null disables recurrence.
Default: null
recurring_settings (anyOf 2)nullAlternative
scheduled_enabledJSONOptional
scheduled_enabled (anyOf 1)booleanAlternativePauses scheduled reminders when false; null preserves the current value.
Default: null
scheduled_enabled (anyOf 2)nullAlternative
should_notify_contract_owner_managersbooleanOptionalDefault: false

Referenced models: Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers notification triggers array item, Create a vendor agreement — request body — body renewal notification settings notification triggers, recipient approval group uuids, recipient dynamic user group uuids, recipient user uuids, recurring settings, scheduled enabled, should notify contract owner managers recurring settings Complete recurring reminder configuration

Update a vendor agreement — request body — body renewal action
FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"CANCELLED": "#/components/schemas/CancelledActionUpdateRequestBody", "EVALUATING": "#/components/schemas/EvaluatingActionUpdateRequestBody", "NOT_STARTED": "#/components/schemas/ActiveActionUpdateRequestBody", "PLANNING": "#/components/schemas/PlanningActionUpdateRequestBody", "RENEWED": "#/components/schemas/RenewedActionUpdateRequestBody", "TERMINATED": "#/components/schemas/TerminatedActionUpdateRequestBody"}, "propertyName": "type"}
$ (oneOf 1)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type NOT STARTED
$ (oneOf 2)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type CANCELLED
$ (oneOf 3)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type EVALUATING
$ (oneOf 4)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type PLANNING
$ (oneOf 5)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type RENEWED
$ (oneOf 6)ModelAlternativeExpand Update a vendor agreement — request body — body renewal action type TERMINATED

Referenced models: Update a vendor agreement — request body — body renewal action type NOT STARTED, Update a vendor agreement — request body — body renewal action type CANCELLED, Update a vendor agreement — request body — body renewal action type EVALUATING, Update a vendor agreement — request body — body renewal action type PLANNING, Update a vendor agreement — request body — body renewal action type RENEWED, Update a vendor agreement — request body — body renewal action type TERMINATED

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

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.