Overview
If you are currently using a Hello Club API, certain changes will be required to ensure a smooth transition after your club portal is upgraded. This guide outlines the necessary steps and key updates to keep your API functioning correctly.
Key Configuration Changes
We will continue to use your existing API key, but we must make changes to its configuration. To proceed, we require additional information from you as soon as possible.
Please provide the following details in the attached spreadsheet:
API Key Name: (Located in your Hello Club portal under Integration -> API key section)
Endpoint URL
HTTP Verb: (e.g., GET, PUT, DELETE)
Description of Endpoint Usage
Query Parameters: (if applicable)
Example of Body Data: (if applicable)
Please complete the spreadsheet and send it to us at [email protected] at your earliest convenience. Once we have reviewed this information, we will apply the necessary updates on our end. Failure to provide this information may result in a temporary loss of service until the API key is updated.
Endpoint Specific Changes
In addition to updating the API key configuration, you will need to adjust the following endpoint changes:
All endpoints are now pluralized (e.g.,
/eventbecomes/events).PUT requests have been replaced by PATCH requests.
Terminology updates:
"club" is now "org"
"member" is now "profile"
"membership" is now "membershipType"
"subscription" is now "membership"
Profile-Specific Changes
A new property, type, must be set to
"person"when creating.The address structure has been updated:
jsonCopy code{ "line1": "String", "line2": "String", "suburb": "String", "postalCode": "String", "city": "String", "state": "String", "country": "String" }Next Steps
Once you receive confirmation of the platform upgrade, you can resume using the Hello Club API after completing and deploying the necessary updates.
Further Support
For more information, visit the Hello Club API Documentation. If you have additional questions or need assistance, please contact us at [email protected].