✅ Personal Fundraising Page Custom Codes

❗️

This API is being retired on September 30th, 2026, and is replaced by the new Cloud API. Please see here for details on how to get started on the Cloud API.

On the Fundraising Platform Custom Codes can be set to add a customisable value to fundraising pages. You can customise the names of the fields and assign the values either one by one or many at once.

The following table contains the fields that are returned within the response call of the personal fundraising pages custom codes endpoint.

KeyLabelTypeDescription
customCodeIdCustom Code IdLongCustom Code Id
pfIdPersonal Fundraising Page IdLongPersonal Fundraising Page Id
valueValueStringCustom Code Value
nameNameStringName of PF page Custom Code
createdDateCreated DateDateDate Supporter Custom Code Created
modifyDateModify DateDateDate Supporter Custom Code Modified

🚀 Returns a list of Personal Fundraising Pages custom codes

/personalFundraisingPageCustomCodes

Get a list of personal fundraising custom codes filterable by the attributes below.

KeyLabelTypeDescription
account_guidsAccount GuidsArray[UUID]Account GUID associated with a charity account.
date_fromDate FromStringDate from which to filter based on the created date of the PFP custom code
date_toDate ToStringDate to filter to based on the created date of the PFP custom code
custom_code_IdsPersonal Fundraising Page IdLongPersonal fundraising page Id associated with the pfp custom code object
limitLimitIntegerNumber of records to be returned in the response
pagePageIntegerThe number of pages to skip before starting to collect the result set

Sample Request

GET - 
http://dataapi.enthuse.com/personalFundraisingPageCustomCodes?
access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&account_guids=00000000-0000-0000-0000-000000000000
&pf_id=123
&custom_code_ids=12345
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-03-01%2000%3A00%3A00
&limit=25
&page=1

Sample Responses:

200 - OK call was successful and returned data

{
    "status": 200,
    "totalCount": 3,
    "pfpCustomCodeCodeList": [
        {
            "customCodeId": 183280,
            "pfId": 6614,
            "value": "",
            "name": "",
            "createdDate": "2022-09-02 09:26:35",
            "modifyDate": "2022-09-02 09:26:35"
        },
        {
            "customCodeId": 193975,
            "pfId": 6614,
            "value": "",
            "name": "",
            "createdDate": "2022-09-02 09:26:35",
            "modifyDate": "2022-09-02 09:26:35"
        },
        {
            "customCodeId": 204314,
            "pfId": 6614,
            "value": "",
            "name": "",
            "createdDate": "2022-09-02 09:26:35",
            "modifyDate": "2022-09-02 09:26:35"
        }
    ]
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - Charity access token used alongside an account guid not associated with charity

{
  "message": "You cannot use an account guid from a separate account",
  "status": 403
}

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
}