v1

latestOpenAPI 3.0.12026-08-06138434618.9 KB
Projects

Update a project

put/v4/projects/{projectId}

Path parameters

projectIdstring uuid required

Request body

namestring required
guidelinesHtmlstring nullable
termsOfUsestring nullable
eligibilityFormIdstring uuid nullable
customIneligibleMessagestring nullable
initialFormIdstring uuid nullable
internalFormIdstring uuid nullable
startsAtstring date-time nullable
endsAtstring date-time nullable
isHiddenboolean
isLiveboolean
isArchivedboolean
shouldHideBlindFieldsboolean
blindLevel'None' | 'Level1' | 'Level2' | 'Level3' | 'Level4' | 'Level5' nullable
requirePublicOrgIdboolean
concealPublicOrgInfoboolean
requireValidatedEmailboolean
enableUsBankCheckPaymentboolean
enableUsBankAchPaymentboolean
enableUsBankPrepaidCardPaymentboolean
usBankPrepaidCardDisclosureUrlstring uri nullable
usBankAchAccountIsIndividualboolean nullable
enableOrganizationSearchboolean
organizationSearchByEINboolean
organizationSearchByUEIboolean
discoverTagsstring[] nullable
defaultNoteVisibility'staff' | 'private' | 'All Staff' | 'Entire Team' nullable
emailOnSubmissionboolean
autoResponseTemplateIdstring nullable
successUrlstring nullable
enforceSubmissionCapboolean
numSubmissionsAllowedinteger
submissionCapDisplaySubmissionCapboolean
sendSubmissionCapNotificationboolean
submissionCapNotificationPercentageinteger nullable
enableCollaborativeDraftsboolean
enableAwardPaymentVisibilityboolean
limitMultipleSubmissionsboolean
enableEditReviewsboolean
enableReimbursementsboolean
allowedFundsstring[] nullable
budgetCategoriesstring[] nullable
organizationSearchAgenciesstring[] nullable
isConcealedboolean
isAdvancedConcealedboolean
visibleRolesstring[] nullable
fundsDistributionAccountIdstring uuid nullable

Response

The updated project

projectIdstring uuid
organizationIdstring uuid
namestring nullable
guidelinesHtmlstring nullable
termsOfUsestring nullable
initialFormIdstring uuid nullable
internalFormIdstring uuid nullable
eligibilityFormIdstring uuid nullable
customIneligibleMessagestring nullable
startsAtstring date-time nullable
endsAtstring date-time nullable
isHiddenboolean
isLiveboolean
isArchivedboolean
shouldHideBlindFieldsboolean
blindLevel'None' | 'Level1' | 'Level2' | 'Level3' | 'Level4' | 'Level5' nullable
createdByUserIdstring uuid
createdAtstring date-time nullable
concealPublicOrgInfoboolean
requirePublicOrgIdboolean
enableCollaborativeDraftsboolean
requireValidatedEmailboolean
enableUsBankCheckPaymentboolean
enableUsBankAchPaymentboolean
enableUsBankPrepaidCardPaymentboolean
usBankPrepaidCardDisclosureUrlstring nullable
usBankAchAccountIsIndividualboolean nullable
enableOrganizationSearchboolean
organizationSearchByEINboolean
organizationSearchByUEIboolean
discoverTagsstring[] nullable
defaultNoteVisibility'staff' | 'private' | 'All Staff' | 'Entire Team' nullable
emailOnSubmissionboolean nullable
autoResponseTemplateIdstring nullable
successUrlstring nullable
enforceSubmissionCapboolean
numSubmissionsAllowedinteger
submissionCapDisplaySubmissionCapboolean
sendSubmissionCapNotificationboolean
submissionCapNotificationPercentageinteger nullable
enableAwardPaymentVisibilityboolean
limitMultipleSubmissionsboolean
enableEditReviewsboolean
totalSubmissionCountinteger
enableReimbursementsboolean
allowedFundsstring[] nullable
budgetCategoriesstring[] nullable
organizationSearchAgenciesstring[] nullable
isConcealedboolean
isAdvancedConcealedboolean
visibleRolesstring[] nullable
fundsDistributionAccountIdstring uuid nullable