Skip to main content
HelpYouSponsor Docs home page
Search...
⌘K
Documentation
Blog
User
POST
User Login
GET
User Logout
POST
Activate User
GET
Check User Activation Status
POST
Send Verification Email
Client
POST
Client payment
PUT
Edit client account
POST
Edit client integration
GET
Get client card details
GET
Get client payment status
GET
Get client payments
GET
Get details of an integration
GET
Get price for client to pay
POST
Update client credit card
GET
View Integrations
Email Settings
GET
Get email settings
POST
Post email settings
Commitments
GET
Edit a commitment
PATCH
Edit multiple commitments
GET
Edit a commitment
GET
Get commitments graph
Dashboard
GET
Get Dashboard Data
Designation
POST
Add a new designation
GET
Designation Details
PUT
Edit a designation
GET
List emailsets and program forms when creating a designation
DEL
Remove a designation
GET
View all designations
GET
List emailsets and program forms when creating a designation
Donations
POST
Add a commitment donation
POST
Add a new donation
GET
Ccommitment details
GET
Donation details
GET
Donation view options
PUT
Edit a donation
GET
Get all donations by a specific donor
GET
Get all donations by donors
GET
Get donations graph
GET
Get form fields for a specific donor group
GET
Refund a donation
DEL
Remove a donation
POST
View all donations
Donor
POST
Add a new donor
GET
Donors table headers
PUT
Edit a donor
GET
Get a donor
GET
Get all donors
GET
Get donor form fields
GET
Get PayPal credentials
POST
Send notification to donors
GET
Send signup email to a donor
POST
Send year end statements to donors
POST
Update donor PayPal credentials
DEL
Delete donor card details
GET
Get donor card details
POST
Select a saved donor report
POST
Update donor credit card details
Donors
POST
Activate donors
POST
Archive donors
GET
Get all donor forms by client id
GET
Get all donors with pagination, search and sort
GET
Get field options for donors
GET
Get statistics of donors
POST
Post field options for donors
DEL
Remove a saved donor view
DEL
Delete donors
Sponsorships
POST
Add a new sponsorship
POST
Archive a sponsorship for a donor
POST
Archive Sponsorships for Donors
GET
Donors and Available Entities
GET
Get Sponsorship Statistics
GET
Get sponsorships for a specific donor
POST
Get Sponsorships Table Headers
POST
Post Sponsorships Next
POST
Restore a sponsorship for a donor
GET
Show All Sponsorships
Email manager
POST
Approve a draft message
PUT
Assign an email to an admin
GET
Get all admins
GET
Get available entities
GET
Get sponsors of an entity
POST
Send an email response
PUT
Update the status of an email
PUT
Update the status of multiple emails
GET
View a specific email
POST
View email manager
PUT
Assign multiple emails to an admin
POST
Create a draft message
GET
Send a message
GET
Send a message
POST
View all admin emails
Auto Emails
POST
Add a new email set
PUT
Edit an email set
PUT
Edit an email template
GET
Get details of an emailset
GET
Manage auto emails
DEL
Remove an email set
GET
Send an email
Entities
GET
Activate Entity
POST
Activate Multiple Entities
POST
Add New Entity
DEL
Archive Entity
GET
Get program recipient form
DEL
Permanently delete an entity
PUT
Post Edit Entity
PATCH
Post Edit Multiple Entities
GET
Show All Entities for a specific program
GET
View Entity Details
DEL
Permanently delete entities
DEL
Archive Entities
DEL
Permanently delete entities
Programs
PUT
Edit a program
GET
Get Detailed Field Options
GET
Get Program Statistics
POST
Move and entity to a different program
PUT
Move Multiple Entities
DEL
Remove a program
DEL
Remove a saved view
GET
View compatible programs when moving entities
GET
Entity table headers
POST
Post Field Options
GET
Select Saved View
Program Forms
POST
Add a form field
POST
Create a new form
DEL
Delete a form
PUT
Edit a form field
GET
Form Details
GET
Form field types
GET
Get all forms
GET
Manage a form
PUT
Update a form
DEL
Delete a form field
Progress Reports
GET
List programs and forms
POST
Post progress report
Admins & Permissions
POST
Add a new admin
GET
Admin details
POST
Create a new group
DEL
Delete a group by ID
PUT
Edit a specific group
PUT
Edit an existing admin
GET
Get a group by ID
GET
List a donors and programs
GET
List permission sets or admin groups
GET
Manually activate an admin
GET
Manually deactivate an admin
DEL
Remove an admin
GET
View all admins
GET
View all groups
Notes
POST
Create a new note
PUT
Edit a note
GET
Get note details
POST
View notes
Program Options
POST
Create a child program
POST
Create a sub program
GET
Get campaign program details
GET
Get details of a specific program
GET
Get program settings
GET
Manage programs
Manage Program
POST
Add a donor form to a program
POST
Add a sponsorship form to a program
POST
Add a submit form to a program
POST
Attach an email set to a program
POST
Attach settings to a program
Settings
POST
Add new setting
DEL
Delete a setting
PUT
Edit a setting
GET
Get all settings
GET
Get details for a setting
GET
Get details for campaign settings
Templates
POST
Post Template
GET
Retrieve Template
Files
DEL
Delete a file
PUT
Edit a file
GET
Get file details
GET
Get files table
POST
Import CSV for a specific program
GET
Import CSV for a specific program
GET
Make placeholder picture
GET
Make profile picture
POST
Post a record upload
POST
Process the import job for donors and recipients
POST
Process the import job for payments
POST
Process the import job for sponsorship relationships
GET
Rotate picture
POST
Upload a file
GET
Upload a file
Frontend
POST
Add a designation to the checkout
GET
Checkout
POST
Create a new donor and process their donation
GET
Forgot Username
GET
Get Login Information
GET
Handle the checkout process for sponsorships
POST
Login a donor and process their donation
POST
Post Forgot Username
POST
Post Login
GET
Post Logout
POST
Post Reset Password
POST
Process a campaign checkout
DEL
Remove a designation from the checkout
DEL
Remove an entity from the checkout
GET
Reset Password
PUT
Update the amount for a specific entity in the checkout
PUT
Update the frequency for a specific designation in the checkout
PUT
Update the frequency of a donation
GET
View a random entity
GET
Display titles and files with pagination
POST
Save an entity
GET
View entity details
Frontend Donor
DEL
Delete a file
GET
Donor Credit Card Information
GET
Donor View Entity Message History
GET
Donor View Entity
GET
Donor View
GET
Get Donor Information
GET
Get files for a donor
GET
Handle Donor File Uploads
POST
Post Donor View Entity Message
POST
Save file upload to database
PUT
Update Donor Information
POST
Update Donor's Credit Card Information
POST
Uploads a file for a donor
Donor Signup
POST
Add a new donor
GET
Sign up a new donor
Wrapped
GET
Get organization's year in review
GET
Check calculation status for wrapped statistics
Support
Go to HYS
HelpYouSponsor Docs home page
Search...
⌘K
Support
Go to HYS
Go to HYS
Search...
Navigation
User Signup Step One
Get Started
API Reference
Get Started
API Reference
User Signup Step One
Handles the first step of user signup, including data validation and user creation.
⌘I