📆 Event Fundraising Pages
You can use an Event Fundraising Page for a number of fundraising activities including appeals and registration events. All of these events will have a unique 'eventPageId'. Fundraisers can create fundraising pages to fundraise towards that event and donors can donate to these pages or the event page itself.
The Event Fundraising Pages endpoints provide you with a summary of the event including whether it is live and the target set.
If the event is created through our Events Platform it will also have a 'campaignGuid' otherwise this field will be empty. You can only use either Campaign Guids or Event Ids but not both at the same time when filtering the responses.
The following table contains the fields that are returned within the response call of the event fundraising page endpoints.
Key | Label | Type | Description |
|---|---|---|---|
eventTitle | Event Title | String | Title of the event |
companyId | Company Id | Long | Unique identifier for the associated company or event. |
charityId | Charity Id | Long | Unique identifier for the associated charity |
target | Target | Long | The target amount set for fundraising |
status | Status | String | Status of the event page; values can be: |
eventUrl | Event Url | String | URL of event |
eventPageId | Event Page Id | Long | Unique identifier for the Event Page |
campaignGuid | Campaign Guid | UUID | Unique identifier (GUID) for events created through the Events Platform |
charityAccountGuid | Charity Account Guid | UUID | Unique identifier (GUID) for the associated charity account. |
companyAccountGuid | Company Account Guid | UUID | Unique identifier (GUID) for the associated company account. |
createdDate | Created Date | Date | The date the event page was created. |
lastUpdatedDate | Last Updated Date | Date | The date the event page was last updated. |
🚀 Search event fundraising pages
Returns a list of event fundraising pages within your account filterable by the attributes below:
Key | Label | Type | Description |
|---|---|---|---|
campaign_guids | Campaign Guids | Array[string] | An array of Campaign GUIDs associated with the event fundraising page, indicating the campaigns linked to this page. |
date_from | Date From | String | Filter based on the created date of the event fundraising page. Specify the starting date to retrieve pages created on or after that date. |
date_to | Date To | String | Filter based on the created date of the event fundraising page. Specify the ending date to retrieve pages created on or before that date. |
new_event_fundraising_pages_only | New Event Fundraising Pages Only | Boolean | When used with date filters, if set to true, the filter will be based only on the created date If false, it will consider both created date and last updated date. Defaults to false. |
event_ids | Event Ids | Array[Long] | Event Ids associated with the event fundraising page object |
limit | Limit | Integer | Specifies the number of records to be returned in the response, controlling the quantity of results in a single request |
page | Page | Integer | Indicates the number of pages to skip before starting to collect the result set. |
ReminderYou can only use either Campaign Guids or Event Ids but not both at the same time
Sample Request
GET - http://dataapi.enthuse.com/eventFundraisingPage?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&campaign_guids=00000000-0000-0000-0000-000000000000
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-03-01%2000%3A00%3A00
&limit=15
&page=1Sample Responses:
200 - OK call was successful and returned data
{
"eventTitle": "Test event",
"companyId": 1,
"charityId": 323614,
"target": 25,
"status": 0,
"eventUrl": "https://demo-company.enthuse-sandbox.com/cf/testing-team-json-69e9b",
"eventPageId": 1242,
"campaignGuid": null,
"charityAccountGuid": "00000000-0000-0000-0000-000000000000",
"companyAccountGuid": "00000000-0000-0000-0000-000000000000",
"createdDate": "2022-03-14T13:33:53.2133333Z"
"lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}401 - Access token has expired or is incorrect
{
"message": "Unauthorized.",
"status": 401
}403 - The account linked to the token does not match the account of the records trying to retrieve
{
"message": "Forbidden.",
"status": 403
}404 - Call authenticated but no records match the searched criteria
{
"message": "No records found.",
"status": 404
}416 - Call authenticated but both eventId and campaignGuid used together
{
"message": "eventId and campaignGuid cannot be used in unison",
"status": 416
}500 - Error occurred within Service, data could not be returned
{
"message": "Internal Server Error.",
"status": 500
}🚀 Search for a specific event fundraising page
/eventFundraisingPage/{event_page_id}
Retrieve details for a specific event fundraising page using a designated event_page_id'.
Customize your query using the following attribute:
Key | Label | Type | Description |
|---|---|---|---|
event_page_id | Event Page Id | Long | Unique identifier for the targeted event fundraising page. Use this ID to filter and fetch specific page details |
Sample Request
GET - http://dataapi.enthuse.com/eventFundraisingPage/1234?access_token=2VgkDXCywbjtViCJT6YsfdtF8DESample Responses:
200 - OK call was successful and returned data
{
"createdDate": "2022-09-22T15:32:38.708Z",
"eventTitle": "string",
"companyId": 7236487,
"charityId": 7236487,
"target": 0,
"status": "string",
"eventUrl": "string",
"eventPageId": 7236487,
"campaignGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"charityAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"companyAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
"lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}401 - Access token has expired or is incorrect
{
"message": "Unauthorized.",
"status": 401
}404 - Call authenticated but no records match the searched criteria
{
"message": "No records found.",
"status": 404
}500 - Error occurred within Service, data could not be returned
{
"message": "Internal Server Error.",
"status": 500
}Updated about 2 months ago