✅ Supporter Custom Codes

On the Donations & Fundraising Platform Custom Codes can be set to add a customisable value to Supporters. 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 supporter custom codes endpoint.

Key	Label	Type	Description
customCodeId	Custom Code Id	Long	Custom Code Id
supporterId	Supporter Id	Long	Supporter Id
value	Value	String	Custom Code Value
name	Name	String	Name of Supporter Custom Code
createdDate	Created Date	Date	Date Supporter Custom Code Created
modifyDate	Modify Date	Date	Date Supporter Custom Code Modified

🚀 Search Supporter Custom Codes

/supporterCustomCodes

Get a list of supporter 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 supporter custom code
date_to	Date To	String	Date to filter to based on the created date of the supporter custom code
custom_code_Ids	Custom Code Ids	Array[Long]	Custom Code Ids associated with the supporter custom code object
supporter_Id	Supporter Id	Long	Supporter Id associated with the supporter 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/supporterCustomCodes?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&account_guids=00000000-0000-0000-0000-000000000000
&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

[ 
 {
	"customCodeId": 1234,
	"supporterId": 3223,
	"value": "1",
	"name": "name",
	"createdDate": "2021-09-21 09:06:44",
	"modifyDate": "2021-09-21 09:06:44"
 },
 {
	"customCodeId": 1235,
	"supporterId": 3223,
	"value": "2",
	"name": "name",
	"createdDate": "2021-09-21 09:06:44",
	"modifyDate": "2021-09-21 09:06:44"
 }
],
"totalCount": 0

401 - Access token has expired or is incorrect

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

403 - Bespoke - 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
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "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
}