Sign in

v1

latestOpenAPI 3.1.02026-07-266850126.1 KB
Campaigns

Update a campaign

put/v1/campaigns/{campaign}

Path parameters

campaigninteger required

The campaign ID

Request body

publishedboolean
publicboolean
type'general' | 'collect' | 'fundraise' | 'event'
titlestring
subtitlestring nullable
websitestring uri nullable
descriptionstring nullable
goalinteger nullable
end_atstring date-time nullable
short_codestring nullable
slugstring
beneficiary_idinteger nullable
timezonestring nullable
currency'USD'
default_appeal_idinteger nullable

Response

CampaignResource

idstring required
codestring required
account_idstring required
event_idstring required
typestring required
titlestring required
subtitlestring required
descriptionstring required
slugstring required
urlstring required
goalinteger nullable required
raisednumber required
donorsinteger required
currencystring required
coverstring required
statusstring required
timezonestring required
end_atstring required
created_atstring required
updated_atstring required