v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Contracts

Update Contract

Use this API to update an existing contract.

put/api/vendor/v1/contracts/{contractId}/vendors/{vendorId}/contracts

Path parameters

contractIdstring uuid required

Example:4d5c76e1-afa3-4d24-a412-c7eadd63cc75

The unique identifier of the contract. The value can be obtained using Get All Eligible Contract Types, Order by Name API.

vendorIdstring uuid required

Example:5c5c76e1-afa3-4d24-a412-c7eadd63cc75

The unique identifier of the vendor. The value can be obtained using List Vendors API.

Request body

namestring required

The display name of the contract that must be unique.

The current status of the agreement.

agreementCreatedDatestring date required

The date when the agreement was created.

contractTypeIdstring uuid

The unique identifier of the contract type.

contractTypeNamestring

The name of the contract type classification.

approvedDatestring date

The date when the contract was approved.

expirationDatestring date

The date when the contract expires.

contractOwnerIdstring uuid

The unique identifier of the contract owner.

contractOwnerEmailstring email

The email address of the contract owner.

vendorContactstring

The contact person for the vendor contract.

approversstring

The list of approvers for the contract.

notestring

The additional notes about the contract.

costnumber

The monetary cost of the contract.

urlstring uri

The URL location of the contract document.

orgGroupIdstring uuid

The unique identifier of the organization group.

attributeValuesobject

The collection of custom attribute values.

Example request

{
  "name": "Microsoft Azure License Agreement",
  "status": "NEW",
  "agreementCreatedDate": "2025-01-15",
  "contractTypeId": "7e7f532b-2427-4f45-84f4-67bdb24c5831",
  "contractTypeName": "Master Service Agreement",
  "approvedDate": "2025-01-20",
  "expirationDate": "2026-01-14",
  "contractOwnerId": "8a732373-9713-4f93-98f6-cae431e61956",
  "contractOwnerEmail": "john.doe@company.com",
  "vendorContact": "Jane Smith (jane.smith@microsoft.com, +1-555-123-4567)",
  "approvers": "alice.johnson@company.com, bob.williams@company.com",
  "note": "This contract covers all Microsoft Azure cloud services used by our IT department. Includes premium support package and training services.",
  "cost": 75000,
  "url": "https://contracts.company.com/azure-license-2025.pdf",
  "orgGroupId": "a41972ae-2050-4126-b314-1a58d08ea116",
  "attributeValues": {
    "priority": [
      {
        "id": "c5c3167e-f8e2-4719-a0a1-491350507fee",
        "value": "High"
      }
    ],
    "department": [
      {
        "id": "d6d4278f-g9f3-5820-b1b2-592461608gff",
        "value": "IT"
      }
    ]
  }
}

Response

idstring uuid

The unique identifier of the returned contract.

namestring

The name of the returned contract.

vendorIdstring uuid

The vendor identifier of the returned contract.

vendorNamestring

The vendor name of the returned contract.

orgGroupIdstring uuid

The organization group of the returned contract.

status'NEW' | 'IN_PROGRESS' | 'ACTIVE' | 'EXPIRED' | 'TERMINATED'

The status of the returned contract.

agreementCreatedDatestring date-time

The creation date of the returned agreement.

contractTypeIdstring uuid

The contract type identifier of returned contract.

contractTypeNamestring

The contract type name of returned contract.

contractTypeNameKeystring

The contract type translation key.

approvedDatestring date

The approval date of the returned contract.

expirationDatestring date

The expiration date of the returned contract.

contractOwnerIdstring uuid

The owner identifier of the returned contract.

contractOwnerstring

The owner name of the returned contract.

vendorContactstring email

The vendor contact of the returned contract.

approversstring

The approvers list of the returned contract.

notestring

The notes of the returned contract.

costnumber

The cost of the returned contract.

urlstring uri

The document URL of the returned contract.

schemaIdstring uuid

The schema identifier of the returned contract.

attributeValuesobject

The custom attributes of the returned contract.

viewOnlyboolean

The read-only flag of the returned contract.

statusKeystring

The status translation key of the returned contract.

Example response

{
  "id": "db3398d0-cbce-4796-b248-614661cf256b",
  "name": "Microsoft Azure Services Agreement",
  "vendorId": "5ec48d61-1562-43ad-87a3-6fc7073494af",
  "vendorName": "Microsoft",
  "orgGroupId": "a41972ae-2050-4126-b314-1a58d08ea116",
  "attachments": [
    {
      "id": "db3398d0-cbce-4796-b248-614661cf256b",
      "attachmentId": "7e7f532b-2427-4f45-84f4-67bdb24c5831",
      "resourcePath": "/contracts/attachments/contract_agreement.pdf",
      "attachmentDescription": "Signed contract agreement document",
      "fileName": "contract_agreement.pdf",
      "createdBy": "John Smith",
      "createdDate": "2023-05-16T14:30:00Z"
    }
  ],
  "status": "ACTIVE",
  "agreementCreatedDate": "2023-05-16T00:00:00.000+00:00",
  "contractTypeId": "3a4d3855-fe68-446d-99e3-90897ab1cc17",
  "contractTypeName": "Privacy Policy",
  "contractTypeNameKey": "PrivacyPolicy",
  "approvedDate": "2023-05-16",
  "expirationDate": "2024-05-15",
  "contractOwnerId": "8a732373-9713-4f93-98f6-cae431e61956",
  "contractOwner": "Antonio",
  "vendorContact": "antanio@microsoft.com",
  "approvers": "amara@microsoft.com, john.doe@company.com",
  "note": "Contract has been updated recently for Microsoft vendor",
  "cost": 10000,
  "url": "https://www.microsoft.com",
  "schemaId": "36e2d4a1-379f-4263-8e05-6e3a3207a834",
  "attributeValues": {
    "attributeSingleSelectValue.value21": [
      {
        "id": "c5c3167e-f8e2-4719-a0a1-491350507fee",
        "valueKey": "OneTrustApp.VRM.Contract.Attributes.e38d9fe7-a5b7-43b0-b79f-ed7940669c99",
        "value": "Recently Updated"
      }
    ]
  },
  "statusKey": "New"
}