Neon One Help Center home page
Neon One Help Center home page
support

Articles in this section

Campaign Object

Last updated

The Campaign object contains information related to a Neon Fundraise campaign.

Availability: The Campaign object is a global object, which means it's available in any email, including email blasts and Admin Email Templates, and in any editable area on the website.

Attributes: The Campaign object has the following attributes:

  • Campaign.Name
  • Campaign.Alternate_Name
  • Campaign.Location
  • Campaign.URL
  • Campaign.Description
  • Campaign.Goal_Amount
  • Campaign.Amount_Raised
  • Campaign.Amount_To_Goal
  • Campaign.Event_Year
  • Campaign.Event_Date
  • Campaign.Dashboard_URL
  • Campaign.Terms

Campaign.Name

Returns the campaign name (for example 5K Run). The campaign name is editable in the campaign details view in the Admin.

Campaign.Alternate_Name

Returns the campaign's alternate name. The alternate campaign name is editable in the campaign details view in the Admin.

Campaign.Location

Returns the campaign's location. The campaign location is editable in the campaign details view in the Admin.

Campaign.URL

Returns a link to the campaign's homepage (for example https://myevent.rallybound.org/5krun). The campaign URL is editable in the campaign details view in the Admin.

Campaign.Description

Returns the campaign's description. The campaign description is editable in the campaign details view in the Admin.

Campaign.Goal_Amount

Returns the campaign's goal amount. Use a moneyfilter to return the value in a monetary format:

Input

{{ Campaign.Goal_Amount | money }}

Output

$100,000

Campaign.Amount_Raised

Returns the total amount raised on the campaign, including amounts donated to fundraisers and teams within the campaign. Registration fees are included in the total by default, please contact us to change that configuration. Use a money filter to return the value in a monetary format:
Input

{{ Campaign.Amount_Raised | money }}

Output

$93,205

Campaign.Amount_To_Goal

Returns the difference between the campaign's total raised and goal. Use a money filter to return the value in a monetary format:

Input

{{ Campaign.Amount_To_Goal | money }}

Output

$6,795

Campaign.Event_Year

Returns the campaign year as set in the campaign details view in the Admin.

Campaign.Event_Date

Returns the event date. The event date is editable in the campaign details view in the Admin. Use a datefilter to return the value in a recognized format:

Input

{{ Campaign.Event_Date | date: "%B %d, %Y" }}

Output

January 1, 2020

Campaign.Dashboard_URL

Returns a link to the campaign's dashboard that resolves correctly for all fundraisers (for example https://myevent.rallybound.org/5krun/headquarters). If a fundraiser is logged in, they will be directed to their dashboard. If they are logged out, they will be redirected to the login page, after which they will be directed to their dashboard. Add parameters at the end of the URL for specific locations in the dashboard. Some examples are listed below. For a full list of dashboard URL destinations, see here.

Input

{{ Campaign.Dashboard_URL }}?tab=email

This directs the fundraiser to the email tab.

Input

{{ Campaign.Dashboard_URL }}?pop=editGoalPop

This will load the dashboard with the edit goal popup activated.

Campaign.Terms

This is an array of global terms used by the given campaign to describe various elements of the campaign, such as "campaign", "user", and "team". This object should be used in conjunction with the term_by_name filter to retrieve a specific term:

Input

Join My {{ Campaign.Terms | term_by_name : "Global_TeamAdjective" }}

Output

Join My Team