User
Client
Email Settings
Commitments
Dashboard
Designation
Donations
- POSTAdd a commitment donation
- POSTAdd a new donation
- GETCcommitment details
- GETDonation details
- GETDonation view options
- PUTEdit a donation
- GETGet all donations by a specific donor
- GETGet all donations by donors
- GETGet donations graph
- GETGet form fields for a specific donor group
- GETRefund a donation
- DELRemove a donation
- POSTView all donations
Donor
- POSTAdd a new donor
- GETDonors table headers
- PUTEdit a donor
- GETGet a donor
- GETGet all donors
- GETGet donor form fields
- GETGet PayPal credentials
- POSTSend notification to donors
- GETSend signup email to a donor
- POSTSend year end statements to donors
- POSTUpdate donor PayPal credentials
- DELDelete donor card details
- GETGet donor card details
- POSTSelect a saved donor report
- POSTUpdate donor credit card details
Donors
Sponsorships
- POSTAdd a new sponsorship
- POSTArchive a sponsorship for a donor
- POSTArchive Sponsorships for Donors
- GETDonors and Available Entities
- GETGet Sponsorship Statistics
- GETGet sponsorships for a specific donor
- POSTGet Sponsorships Table Headers
- POSTPost Sponsorships Next
- POSTRestore a sponsorship for a donor
- GETShow All Sponsorships
Email manager
- POSTApprove a draft message
- PUTAssign an email to an admin
- GETGet all admins
- GETGet available entities
- GETGet sponsors of an entity
- POSTSend an email response
- PUTUpdate the status of an email
- PUTUpdate the status of multiple emails
- GETView a specific email
- POSTView email manager
- PUTAssign multiple emails to an admin
- POSTCreate a draft message
- GETSend a message
- View a message
- POSTView all admin emails
Auto Emails
Entities
- GETActivate Entity
- POSTActivate Multiple Entities
- POSTAdd New Entity
- DELArchive Entity
- GETGet program recipient form
- DELPermanently delete an entity
- PUTPost Edit Entity
- PATCHPost Edit Multiple Entities
- GETShow All Entities for a specific program
- GETView Entity Details
- Bulk delete entities
- DELArchive Entities
- DELPermanently delete entities
Programs
Program Forms
Progress Reports
Admins & Permissions
- POSTAdd a new admin
- GETAdmin details
- POSTCreate a new group
- DELDelete a group by ID
- PUTEdit a specific group
- PUTEdit an existing admin
- GETGet a group by ID
- GETList a donors and programs
- GETList permission sets or admin groups
- GETManually activate an admin
- GETManually deactivate an admin
- DELRemove an admin
- GETView all admins
- GETView all groups
Program Options
Manage Program
Settings
Files
- DELDelete a file
- PUTEdit a file
- GETGet file details
- GETGet files table
- POSTImport CSV for a specific program
- GETImport CSV for a specific program
- GETMake placeholder picture
- GETMake profile picture
- POSTPost a record upload
- POSTProcess the import job for donors and recipients
- POSTProcess the import job for payments
- POSTProcess the import job for sponsorship relationships
- GETRotate picture
- POSTUpload a file
- GETUpload a file
Frontend
- POSTAdd a designation to the checkout
- GETCheckout
- POSTCreate a new donor and process their donation
- GETForgot Username
- GETGet Login Information
- GETHandle the checkout process for sponsorships
- POSTLogin a donor and process their donation
- POSTPost Forgot Username
- POSTPost Login
- GETPost Logout
- POSTPost Reset Password
- POSTProcess a campaign checkout
- DELRemove a designation from the checkout
- DELRemove an entity from the checkout
- GETReset Password
- PUTUpdate the amount for a specific entity in the checkout
- PUTUpdate the frequency for a specific designation in the checkout
- PUTUpdate the frequency of a donation
- GETView a random entity
- GETDisplay titles and files with pagination
- POSTSave an entity
- GETView entity details
Frontend Donor
- DELDelete a file
- GETDonor Credit Card Information
- GETDonor View Entity Message History
- GETDonor View Entity
- GETDonor View
- GETGet Donor Information
- GETGet files for a donor
- GETHandle Donor File Uploads
- POSTPost Donor View Entity Message
- POSTSave file upload to database
- PUTUpdate Donor Information
- POSTUpdate Donor's Credit Card Information
- POSTUploads a file for a donor
Donor Signup
Frontend
Get Login Information
Retrieves login information and related details for a specific client and program.
GET
/
frontend
/
login
/
{client_id}
/
{program_id}
/
{session_id}
Get Login Information
curl --request GET \
--url https://api.helpyousponsor.com/v1/frontend/login/{client_id}/{program_id}/{session_id}{
"session_id": "<string>",
"client_id": 123,
"program_id": 123,
"disable_program_link": "<string>",
"organization": "<string>",
"logo": "<string>",
"login": "<string>",
"currency_symbol": "<string>",
"total": 123
}Documentation Index
Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
Use this file to discover all available pages before exploring further.
Path Parameters
Client ID for which to retrieve login information
Program ID for which to retrieve login information
Session ID for the current user session (optional)
⌘I
Get Login Information
curl --request GET \
--url https://api.helpyousponsor.com/v1/frontend/login/{client_id}/{program_id}/{session_id}{
"session_id": "<string>",
"client_id": 123,
"program_id": 123,
"disable_program_link": "<string>",
"organization": "<string>",
"logo": "<string>",
"login": "<string>",
"currency_symbol": "<string>",
"total": 123
}