Ramp: Update a vendor agreement — request body — body
Update a vendor agreement: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Update a vendor agreement — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
auto_renewal | boolean | Optional | Whether the agreement automatically renews. |
contract_owner_ids | array | Optional | List of contract owner user IDs. |
contract_owner_ids[] | string | Each item | Format: uuid |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the vendor agreement. |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | End date of the agreement. Format: date |
end_date (anyOf 2) | null | Alternative | |
last_date_to_terminate | JSON | Optional | |
last_date_to_terminate (anyOf 1) | string | Alternative | Last date by which the agreement can be terminated. Format: date |
last_date_to_terminate (anyOf 2) | null | Alternative | |
name | string | Optional | Name of the vendor agreement. Minimum length: 1 |
notifications_on | boolean | Optional | Whether notifications are enabled for this agreement. |
renewal_action | Model | Optional | Expand 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_settings | JSON | Optional | |
renewal_notification_settings (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
renewal_notification_snooze | JSON | Optional | |
renewal_notification_snooze (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
renewal_notification_snoozed_until | JSON | Optional | |
renewal_notification_snoozed_until (anyOf 1) | string | Alternative | Date 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) | null | Alternative | |
start_date | string | Optional | Start date of the agreement. Format: date |
total_value | Model | Optional | Expand 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