✅ Personal Fundraising Page Custom Codes

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.

Key

Label

Type

Description

customCodeId

Custom Code Id

Long

Custom Code Id

pfId

Personal Fundraising Page Id

Long

Personal Fundraising Page Id

value

Value

String

Custom Code Value

name

Name

String

Name of PF page Custom Code

createdDate

Created Date

Date

Date Supporter Custom Code Created

modifyDate

Modify Date

Date

Date 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.

Key

Label

Type

Description

account_guids

Account Guids

Array[UUID]

Account GUID associated with a charity account.

date_from

Date From

String

Date from which to filter based on the created date of the PFP custom code

date_to

Date To

String

Date to filter to based on the created date of the PFP custom code

custom_code_Ids

Personal Fundraising Page Id

Long

Personal fundraising page Id associated with the pfp custom code object

limit

Limit

Integer

Number of records to be returned in the response

page

Page

Integer

The 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
}