Update a Project

PUT

/api/Project/:projectId

PUT

/api/Project/:projectId

curl -X PUT "https://api.virtuoussoftware.com/api/Project/projectId?disableWebhookUpdates=%3Cboolean%3E" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "<string>",
  "revenueAccountingCode": "<string>",
  "inventoryStatus": "<string>",
  "type": "<string>",
  "location": "<string>",
  "onlineDisplayName": "<string>",
  "description": "<string>",
  "externalAccountingCode": "<string>",
  "durationType": "<string>",
  "startDate": "<dateTime>",
  "endDate": "<dateTime>",
  "financialNeedAmount": "<double>",
  "financialNeedType": "<string>",
  "financialNeedFrequency": "<string>",
  "isPublic": "<boolean>",
  "isActive": "<boolean>",
  "isAvailableOnline": "<boolean>",
  "isLimitedToFinancialNeed": "<boolean>",
  "isTaxDeductible": "<boolean>",
  "treatAsAccountsPayable": "<boolean>",
  "isRestrictedToGiftSpecifications": "<boolean>",
  "parentId": "<integer>",
  "beginningBalance": "<double>",
  "currentBalance": "<double>",
  "enableSync": "<boolean>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}'

200Projects_updateAProject_example

{
  "id": "<integer>",
  "name": "<string>",
  "projectCode": "<string>",
  "externalAccountingCode": "<string>",
  "onlineDisplayName": "<string>",
  "description": "<string>",
  "photoUrl": "<string>",
  "parentId": "<integer>",
  "parentName": "<string>",
  "isSubProject": "<boolean>",
  "inventoryStatus": "<string>",
  "type": "<string>",
  "location": "<string>",
  "isRestrictedToGiftSpecifications": "<boolean>",
  "isLimitedToFinancialNeed": "<boolean>",
  "isPublic": "<boolean>",
  "isActive": "<boolean>",
  "isAvailableOnline": "<boolean>",
  "isTaxDeductible": "<boolean>",
  "treatAsAccountsPayable": "<boolean>",
  "beginningBalance": "<double>",
  "currentBalance": "<double>",
  "financialNeedType": "<string>",
  "financialNeedFrequency": "<string>",
  "financialNeedAmount": "<double>",
  "startDate": "<dateTime>",
  "endDate": "<dateTime>",
  "durationType": "<string>",
  "lifeToDateGiving": "<double>",
  "lifeToDateGiftCount": "<integer>",
  "lifeToDateGiversCount": "<integer>",
  "lifeToDateExpenseTotal": "<double>",
  "calendarYearToDateGiving": "<double>",
  "calendarYearToDateGiftCount": "<integer>",
  "calendarYearToDateGiversCount": "<integer>",
  "calendarYearToDateExpenseTotal": "<double>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "giftSpecifications": [
    {
      "amount": "<double>",
      "frequency": "<string>"
    },
    {
      "amount": "<double>",
      "frequency": "<string>"
    }
  ],
  "customFields": "<object>"
}

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

projectIdstringRequired

Query parameters

disableWebhookUpdatesstringOptional

Optional name of type of webhook exclusion

Request

This endpoint expects an object.

namestringOptional

revenueAccountingCodestringOptional

inventoryStatusstringOptional

typestringOptional

locationstringOptional

onlineDisplayNamestringOptional

descriptionstringOptional

externalAccountingCodestringOptional

durationTypestringOptional

startDatestringOptional

endDatestringOptional

financialNeedAmountstringOptional

financialNeedTypestringOptional

financialNeedFrequencystringOptional

isPublicstringOptional

isActivestringOptional

isAvailableOnlinestringOptional

isLimitedToFinancialNeedstringOptional

isTaxDeductiblestringOptional

treatAsAccountsPayablestringOptional

isRestrictedToGiftSpecificationsstringOptional

parentIdstringOptional

beginningBalancestringOptional

currentBalancestringOptional

enableSyncstringOptional

customFieldslist of objectsOptional

Response

idstringOptional

namestringOptional

projectCodestringOptional

externalAccountingCodestringOptional

onlineDisplayNamestringOptional

descriptionstringOptional

photoUrlstringOptional

parentIdstringOptional

parentNamestringOptional

isSubProjectstringOptional

inventoryStatusstringOptional

typestringOptional

locationstringOptional

isRestrictedToGiftSpecificationsstringOptional

isLimitedToFinancialNeedstringOptional

isPublicstringOptional

isActivestringOptional

isAvailableOnlinestringOptional

isTaxDeductiblestringOptional

treatAsAccountsPayablestringOptional

beginningBalancestringOptional

currentBalancestringOptional

financialNeedTypestringOptional

financialNeedFrequencystringOptional

financialNeedAmountstringOptional

startDatestringOptional

endDatestringOptional

durationTypestringOptional

lifeToDateGivingstringOptional

lifeToDateGiftCountstringOptional

lifeToDateGiversCountstringOptional

lifeToDateExpenseTotalstringOptional

calendarYearToDateGivingstringOptional

calendarYearToDateGiftCountstringOptional

calendarYearToDateGiversCountstringOptional

calendarYearToDateExpenseTotalstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

giftSpecificationslist of objectsOptional

customFieldsstringOptional