SchoolSet APIFundraising

Update a fundraising campaign

Updates the supplied campaign fields and synchronizes submitted donation types. All request fields are optional; date values must use the ISO-8601 format accepted by UpdateFundraisingRequest. The response is the updated campaign resource.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired
Campaign identifier to update.

Request

This endpoint expects an object.
fundraising_fund_idintegerOptional
campaign_namestringOptional<=1000 characters
descriptionstring or nullOptional
legal_namestringOptional<=1000 characters
tax_idstringOptional<=255 characters
start_datedatetime or nullOptional
end_datedatetime or nullOptional
total_amountdouble or nullOptional>=0
success_payment_messagestring or nullOptional<=255 characters
show_amountboolean or nullOptional
emailstring or nullOptional<=255 characters
phonestring or nullOptional<=255 characters
fundraising_donation_type_sortlist of integers or nullOptional
fundraising_donation_typeslist of maps from strings to any or nullOptional
file_manager_idinteger or nullOptional
merchant_account_idinteger or nullOptional
use_custom_pageboolean or nullOptional

Response

Campaign updated; data uses the FundraisingResource shape returned by the create operation.

statusstring
messagestring
datamap from strings to any

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error