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.
API Usage Changes
You will need to make changes to your API calls to work correctly with Hello Club V2:
The API domain is now
api-v2.helloclub.com.All endpoints are now pluralised (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"
E.g. "https://api.helloclub.com/member" changes to "https://api-v2.helloclub.com/profiles".
Profile-Specific Changes
A new property, type, must be set to
"person"when creating a profile.The address structure has been updated as follows:
{
"line1": "String",
"line2": "String",
"suburb": "String",
"postalCode": "String",
"city": "String",
"state": "String",
"country": "String"
}
Rate Limits
API rate limits remain at 30 requests per minute, the same as they were in V1. To better facilitate handling this rate limit though, V2 now provides a "Retry-After" header whenever it sends 429 a response. This header specifies the number of seconds you need to wait before retrying. It is highly recommended that you check this header and handle it appropriately, rather than relying on fixed delays, in case our rate limits ever change.
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].