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
- GETSend 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
- DELPermanently 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
Checkout
Order to sponsor an entity
GET
/
frontend
/
order
/
{client_id}
/
{program_id}
/
{session_id}
Checkout
Copy
curl --request GET \
--url https://api.helpyousponsor.com/v1/frontend/order/{client_id}/{program_id}/{session_id}Copy
{
"status": "success",
"data": {
"session_id": "abc123",
"client_id": 1,
"program_id": 1,
"signup_fields": [
"<string>"
],
"text_checkout": "Checkout",
"useCC": true,
"isDonorCardActive": true,
"session_logged_in": true,
"login_box": "Login Box",
"num_of_sponsorships": 1,
"payment_options": [
"<string>"
],
"hide_payment_method": false,
"default_payment_method": "Credit Card",
"months": {
"10": "10 - October",
"11": "11 - November",
"12": "12 - December",
"01": "01 - January",
"02": "02 - February",
"03": "03 - March",
"04": "04 - April",
"05": "05 - May",
"06": "06 - June",
"07": "07 - July",
"08": "08 - August",
"09": "09 - September"
},
"years": {
"2022": 2022,
"2023": 2023,
"2024": 2024,
"2025": 2025,
"2026": 2026,
"2027": 2027,
"2028": 2028,
"2029": 2029,
"2030": 2030,
"2031": 2031
},
"stripe_pubkey": "pk_test_1234",
"processing_fee": "$5.00",
"processing_percentage": "2.9%",
"num_sponsorships": 1
}
}Path Parameters
The id of the client
The id of the program
Session ID
Response
Successful operation
Example:
"success"
Show child attributes
Show child attributes
Example:
"abc123"
Example:
1
Example:
1
Example:
"Checkout"
Example:
true
Example:
true
Example:
true
Example:
"Login Box"
Example:
1
Example:
false
Example:
"Credit Card"
Show child attributes
Show child attributes
Example:
"10 - October"
Example:
"11 - November"
Example:
"12 - December"
Example:
"01 - January"
Example:
"02 - February"
Example:
"03 - March"
Example:
"04 - April"
Example:
"05 - May"
Example:
"06 - June"
Example:
"07 - July"
Example:
"08 - August"
Example:
"09 - September"
Show child attributes
Show child attributes
Example:
2022
Example:
2023
Example:
2024
Example:
2025
Example:
2026
Example:
2027
Example:
2028
Example:
2029
Example:
2030
Example:
2031
Example:
"pk_test_1234"
Example:
"$5.00"
Example:
"2.9%"
Example:
1
⌘I
Checkout
Copy
curl --request GET \
--url https://api.helpyousponsor.com/v1/frontend/order/{client_id}/{program_id}/{session_id}Copy
{
"status": "success",
"data": {
"session_id": "abc123",
"client_id": 1,
"program_id": 1,
"signup_fields": [
"<string>"
],
"text_checkout": "Checkout",
"useCC": true,
"isDonorCardActive": true,
"session_logged_in": true,
"login_box": "Login Box",
"num_of_sponsorships": 1,
"payment_options": [
"<string>"
],
"hide_payment_method": false,
"default_payment_method": "Credit Card",
"months": {
"10": "10 - October",
"11": "11 - November",
"12": "12 - December",
"01": "01 - January",
"02": "02 - February",
"03": "03 - March",
"04": "04 - April",
"05": "05 - May",
"06": "06 - June",
"07": "07 - July",
"08": "08 - August",
"09": "09 - September"
},
"years": {
"2022": 2022,
"2023": 2023,
"2024": 2024,
"2025": 2025,
"2026": 2026,
"2027": 2027,
"2028": 2028,
"2029": 2029,
"2030": 2030,
"2031": 2031
},
"stripe_pubkey": "pk_test_1234",
"processing_fee": "$5.00",
"processing_percentage": "2.9%",
"num_sponsorships": 1
}
}