descriptionstring nullable
endDatestring date-time nullable
The datetime of the activity end
privateTitlestring nullable
Private Title : displayed only in the organization back office
startDatestring date-time nullable
The datetime of the activity start
titlestring required
The title of the form. It will be used to generate the url which that can't be changed.
activityTypeIdinteger nullable
Activity type identifier, matching one of the provided type values <a href="index#!/Values/Values_Get"> provided here</a>
saleEndDatestring date-time nullable
The datetime (Inclusive) at which the sales end.
If null the orders will be available until the end of the campaign.
saleStartDatestring date-time nullable
The datetime (Inclusive) at which the users can start placing orders.
If null the orders will be available as soon as the campaign is published.
validityType'MovingYear' | 'Custom' | 'Illimited'
Enum which represents the membership validity type
acceptOpenDonationboolean
Whether the user will be allowed to make a single open donation with an order. The amount of the donation is open, but 3 presets can be set in OpenDonationPresetAmount
acceptOpenMonthlyDonationboolean
Whether the user will be allowed to make a monthly open donation for donation forms
widgetButtonTextstring nullable
The text displayed in the widget button
displayContributorNameboolean
Display contributor name for fundraiser and donation forms.
displayParticipantsCountboolean
Indicates that the members count must be displayed on the form.
displayRemainingEntriesboolean
Indicates that the remaining entries must be displayed on the form.
financialGoalinteger nullable
Indicates the financial goal (amount of money raised) for the whole form. Null means no goal.
generateMembershipCardsboolean
Entrust the issuance of membership cards to HelloAsso (automatically sent by email to participants)
generateTicketsboolean
Entrust the issuance of tickets to HelloAsso (automatically sent by email to participants)
invertDescriptionsboolean
Allows you to add the long description above the store catalog.
labelConditionsAndTermsFilestring nullable
Label conditions and terms file
longDescriptionstring nullable
The long description of the form (rich Html)
openDonationPresetAmountsinteger[] nullable
The preset amounts to be shown to the user. Maximum 3 amounts.
personalizedMessagestring nullable
Personalized message for participants
projectBeneficiariesstring nullable
The project beneficiaries of the form (rich Html)
projectExpensesDetailsstring nullable
Details of the project expenses (rich Html)
projectOwnersstring nullable
Description of the project owners (rich Html)
suggestMonthlyDonationboolean
Suggest monthly donation for donation forms.
displayMonthlyDonationsFirstboolean
The monthly donation option should be displayed or selected by default for donation forms.
projectTargetCountrystring nullable
allowOrganismPayerboolean
Whether users are allowed to contribute to this form through an organism (only for donation and crowdfunding).
allowIndividualPayerboolean
Whether user are allowed to personally contribute to this form (only for donation and crowdfunding).
remindAbandonedCartboolean
Whether a reminder email should be sent for abandoned carts.
displayVersioninteger nullable
The form display version (only for membership).
maxEntriesinteger nullable
Indicates the maximum available entries for the whole form. Null means unlimited entries.