Update a Grant

PUT

/api/Grant/:grantId

PUT

/api/Grant/:grantId

curl -X PUT https://api.virtuoussoftware.com/api/Grant/grantId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "ownerId": "<integer>",
  "title": "<string>",
  "grantingOrganizationId": "<integer>",
  "description": "<string>",
  "referenceId": "<string>",
  "receivingOrganizationId": "<integer>",
  "projectId": "<integer>",
  "dueDate": "<dateTime>",
  "totalAnticipatedAmount": "<double>",
  "status": "<string>",
  "submissionDate": "<dateTime>",
  "anticipatedAwardDate": "<dateTime>",
  "pointOfContactName": "<string>",
  "pointOfContactEmail": "<string>",
  "pointOfContactPhone": "<string>",
  "website": "<string>",
  "awardedGrant": "<boolean>",
  "awardedAmount": "<double>",
  "awardedDate": "<dateTime>",
  "awardTerms": "<string>",
  "grantType": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

{
  "id": "<integer>",
  "grantUrl": "<string>",
  "giftsAppliedUrl": "<string>",
  "ownerId": "<integer>",
  "title": "<string>",
  "grantingOrganizationId": "<integer>",
  "grantingOrganizationUrl": "<string>",
  "description": "<string>",
  "referenceId": "<string>",
  "receivingOrganizationId": "<integer>",
  "receivingOrganizationUrl": "<string>",
  "projectUrl": "<string>",
  "projectId": "<integer>",
  "project": "<string>",
  "dueDateUtc": "<dateTime>",
  "totalAnticipatedAmount": "<double>",
  "status": "<string>",
  "submissionDateUtc": "<dateTime>",
  "anticipatedAwardDateUtc": "<dateTime>",
  "pointOfContactName": "<string>",
  "pointOfContactEmail": "<string>",
  "pointOfContactPhone": "<string>",
  "website": "<string>",
  "awardedGrant": "<boolean>",
  "awardedAmount": "<double>",
  "awardedDateUtc": "<dateTime>",
  "awardTerms": "<string>",
  "grantType": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

grantIdstringRequired

Request

This endpoint expects an object.

ownerIdstringOptional

titlestringOptional

grantingOrganizationIdstringOptional

descriptionstringOptional

referenceIdstringOptional

receivingOrganizationIdstringOptional

projectIdstringOptional

dueDatestringOptional

totalAnticipatedAmountstringOptional

statusstringOptional

submissionDatestringOptional

anticipatedAwardDatestringOptional

pointOfContactNamestringOptional

pointOfContactEmailstringOptional

pointOfContactPhonestringOptional

websitestringOptional

awardedGrantstringOptional

awardedAmountstringOptional

awardedDatestringOptional

awardTermsstringOptional

grantTypestringOptional

customFieldslist of objectsOptional

Response

idstringOptional

grantUrlstringOptional

giftsAppliedUrlstringOptional

ownerIdstringOptional

titlestringOptional

grantingOrganizationIdstringOptional

grantingOrganizationUrlstringOptional

descriptionstringOptional

referenceIdstringOptional

receivingOrganizationIdstringOptional

receivingOrganizationUrlstringOptional

projectUrlstringOptional

projectIdstringOptional

projectstringOptional

dueDateUtcstringOptional

totalAnticipatedAmountstringOptional

statusstringOptional

submissionDateUtcstringOptional

anticipatedAwardDateUtcstringOptional

pointOfContactNamestringOptional

pointOfContactEmailstringOptional

pointOfContactPhonestringOptional

websitestringOptional

awardedGrantstringOptional

awardedAmountstringOptional

awardedDateUtcstringOptional

awardTermsstringOptional

grantTypestringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error