RallyUp Development Log: 3-17-2026
API v2 Documentation Update
Release Date: 3-18-2026
This API update adds organization-level endpoints to create participants and teams for campaigns, plus new endpoints to retrieve custom field metadata. Existing authentication for organizational API calls remains unchanged.
New Endpoints:
- GET /v2/api/getParticipantCustomFields — Returns custom field definitions for participants for a specified campaign.
- GET /v2/api/getTeamCustomFields — Returns custom field definitions for teams for a specified campaign.
- POST /v2/api/createParticipants — Creates participants for a specified campaign (supports optional custom fields).
- POST /v2/api/createTeams — Creates teams for a specified campaign (supports optional custom fields).
- GET /v2/api/getCountriesAndRegions — Returns available countries and regions for populating participant mailing addresses (no parameters).
Key Request/Response Details:
Custom field metadata responses (participants and teams)
- Both custom field endpoints return an array of Custom Field Objects with: CustomfieldId, CustomfieldName, CustomFieldType (e.g., text, checkboxes, dropdown, multiple choice), and CustomFieldTypeValues (array of allowed values for dropdown/multiple choice).
- If a custom field is configured with “Add an ‘other’ option”, include Other as an additional value in CustomFieldTypeValues.
POST /v2/api/createParticipants:
- Params: CampaignID (required).
- Body (required): ParticipantFirstName, ParticipantLastName.
- Body (optional): FundraisingGoal, FundraisingPageDescription (defaults to campaign default if blank), TeamID, ParticipantEmailAddress, ParticipantPhoneNumber, ParticipantUnitsGoal, LastNamePrivate, FundraisingURL.
- Registration:RegistrationOption is renamed to RegistrationOptionID and now accepts an ID (not a name).
- Athon support: add optional AthonActivityID (populate when Athon is enabled).
- ParticipantMailingAddress: optional object with RegistrationAddressLine1, RegistrationAddressLine2, RegistrationAddressLine3, RegistrationCountryID, RegistrationCity, RegistrationRegionID. Use GET /v2/api/getCountriesAndRegions to retrieve valid country/region values.
- CustomFields: optional array of objects { CustomFieldID, CustomFieldValue }. For checkbox custom fields, CustomFieldValue is an array of selected values.
POST /v2/api/createTeams:
- Params: CampaignID (required).
- Body (required): TeamName.
- Body (optional): FundraisingGoal, FundraisingPageDescription (defaults to campaign default if blank), TeamEmailAddress, FundraisingURL.
- Registration:RegistrationOption is renamed to RegistrationOptionID and now accepts an ID (not a name).
- CustomFields: optional array of objects { CustomFieldID, CustomFieldValue }. For checkbox custom fields, CustomFieldValue is an array of selected values.
Renamed endpoints (backward-incompatible):
- getParticipantRegistrations → getParticipantRegistrationTypes
- getTeamRegistrations → getTeamRegistrationTypes
If you have any issues, please contact us partners@rallyup.com.