# Get Dashboard Data
Source: https://api-docs.helpyousponsor.com/api-reference/admin-dashboard/get-dashboard-data

get /dashboard



# Add a new admin
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/add-a-new-admin

post /client/admin/{client_id}



# Admin details
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/admin-details

get /client/admins/{admin_id}



# Create a new group
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/create-a-new-group

post /admin/groups



# Delete a group by ID
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/delete-a-group-by-id

delete /admin/groups/{group_id}



# Edit a specific group
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/edit-a-specific-group

put /admin/groups/{group_id}



# Edit an existing admin
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/edit-an-existing-admin

put /client/admins/{admin_id}



# Get a group by ID
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/get-a-group-by-id

get /admin/groups/{group_id}



# List a donors and  programs
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/list-a-donors-and-programs

get /admin/createGroup



# List permission sets or admin groups
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/list-permission-sets-or-admin-groups

get /client/admin/{client_id}



# Manually activate an admin
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/manually-activate-an-admin

get /admin/account/{id}/activate



# Manually deactivate an admin
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/manually-deactivate-an-admin

get /admin/account/{id}/deactivate



# Remove an admin
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/remove-an-admin

delete /client/admins/{admin_id}



# View all admins
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/view-all-admins

get /admins



# View all groups
Source: https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/view-all-groups

get /admin/groups



# Add a new email set
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/add-a-new-email-set

post /admin/auto_emails/emailset



# Edit an email set
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/edit-an-email-set

put /admin/auto_emails/emailset



# Edit an email template
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/edit-an-email-template

put /admin/auto_emails/template



# Get details of an emailset
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/get-details-of-an-emailset

get /admin/auto_emails/emailset/{emailset_id}



# Manage auto emails
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/manage-auto-emails

get /admin/auto_emails



# Remove an email set
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/remove-an-email-set

delete /admin/auto_emails/emailset/{emailset_id}



# Send an email
Source: https://api-docs.helpyousponsor.com/api-reference/auto-emails/send-an-email

get /admin/auto_emails/send/{program_id}/{trigger}/{to}/{donor_id}/{entity_id}



# Client payment
Source: https://api-docs.helpyousponsor.com/api-reference/client/client-payment

post /client/pay



# Edit client account
Source: https://api-docs.helpyousponsor.com/api-reference/client/edit-client-account

put /client



# Edit client integration
Source: https://api-docs.helpyousponsor.com/api-reference/client/edit-client-integration

post /integrations/{name}



# Get client card details
Source: https://api-docs.helpyousponsor.com/api-reference/client/get-client-card-details

get /client/credit-card



# Get client payment status
Source: https://api-docs.helpyousponsor.com/api-reference/client/get-client-payment-status

get /client/{id}/payment-status



# Get client payments
Source: https://api-docs.helpyousponsor.com/api-reference/client/get-client-payments

get /client/payments



# Get details of an integration
Source: https://api-docs.helpyousponsor.com/api-reference/client/get-details-of-an-integration

get /integrations/{name}



# Get price for client to pay
Source: https://api-docs.helpyousponsor.com/api-reference/client/get-price-for-client-to-pay

get /client/{id}/price



# Update client credit card
Source: https://api-docs.helpyousponsor.com/api-reference/client/update-client-credit-card

post /client/credit-card



# View Integrations
Source: https://api-docs.helpyousponsor.com/api-reference/client/view-integrations

get /integrations



# Edit a commitment
Source: https://api-docs.helpyousponsor.com/api-reference/commitments/edit-a-commitment

get /admin/commitments/{commitment_id}



# Edit multiple commitments
Source: https://api-docs.helpyousponsor.com/api-reference/commitments/edit-multiple-commitments

patch /admin/commitments



# Get commitments graph
Source: https://api-docs.helpyousponsor.com/api-reference/commitments/get-commitments-graph

get /commitments/{date_from}/{date_to}/graph



# Add a new designation
Source: https://api-docs.helpyousponsor.com/api-reference/designation/add-a-new-designation

post /admin/designation



# Designation Details
Source: https://api-docs.helpyousponsor.com/api-reference/designation/designation-details

get /admin/designation/{designation_id}



# Edit a designation
Source: https://api-docs.helpyousponsor.com/api-reference/designation/edit-a-designation

put /admin/designation/{designation_id}



# List emailsets and program forms when creating a designation
Source: https://api-docs.helpyousponsor.com/api-reference/designation/list-emailsets-and-program-forms-when-creating-a-designation

get /admin/designation



# Remove a designation
Source: https://api-docs.helpyousponsor.com/api-reference/designation/remove-a-designation

delete /admin/designation/{designation_id}



# View all designations
Source: https://api-docs.helpyousponsor.com/api-reference/designation/view-all-designations

get /admin/designations



# Add a commitment donation
Source: https://api-docs.helpyousponsor.com/api-reference/donations/add-a-commitment-donation

post /admin/commitment/{commitment_id}/donation



# Add a new donation
Source: https://api-docs.helpyousponsor.com/api-reference/donations/add-a-new-donation

post /admin/donation



# Ccommitment details
Source: https://api-docs.helpyousponsor.com/api-reference/donations/ccommitment-details

get /admin/commitment/{commitment_id}/donation



# Donation details
Source: https://api-docs.helpyousponsor.com/api-reference/donations/donation-details

get /admin/donation/{donation_id}



# Donation view options
Source: https://api-docs.helpyousponsor.com/api-reference/donations/donation-view-options

get /admin/donations/options



# Edit a donation
Source: https://api-docs.helpyousponsor.com/api-reference/donations/edit-a-donation

put /admin/donation/{donation_id}



# Get all donations by a specific donor
Source: https://api-docs.helpyousponsor.com/api-reference/donations/get-all-donations-by-a-specific-donor

get /admin/donors/{donor_id}/donations



# Get all donations by donors
Source: https://api-docs.helpyousponsor.com/api-reference/donations/get-all-donations-by-donors

get /admin/donors/donations



# Get donations graph
Source: https://api-docs.helpyousponsor.com/api-reference/donations/get-donations-graph

get /donations/{date_from}/{date_to}/graph



# Get form fields for a specific donor group
Source: https://api-docs.helpyousponsor.com/api-reference/donations/get-form-fields-for-a-specific-donor-group

get /admin/form/{donor_group}/fields



# Refund a donation
Source: https://api-docs.helpyousponsor.com/api-reference/donations/refund-a-donation

get /admin/donation/{donation_id}/refund



# Remove a donation
Source: https://api-docs.helpyousponsor.com/api-reference/donations/remove-a-donation

delete /admin/donation/{donation_id}



# View all donations
Source: https://api-docs.helpyousponsor.com/api-reference/donations/view-all-donations

post /admin/donations/{all}



# Add a new donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor-signup/add-a-new-donor

post /frontend/signup_donor/{client_id}/{program_id}/{session_id}



# Sign up a new donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor-signup/sign-up-a-new-donor

get /frontend/signup_donor/{client_id}/{program_id}/{session_id}



# Add a new donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor/add-a-new-donor

post /admin/donor/{hysform_id}



# Delete donor card details
Source: https://api-docs.helpyousponsor.com/api-reference/donor/delete-donor-card-details

delete /admin/donor-credit-card/{donor_id}



# Donors table headers
Source: https://api-docs.helpyousponsor.com/api-reference/donor/donors-table-headers

get /admin/donors/{hysform_id}/headers/{trashed}



# Edit a donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor/edit-a-donor

put /donor/{id}/edit



# Get a donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor/get-a-donor

get /donor/{id}



# Get all donors
Source: https://api-docs.helpyousponsor.com/api-reference/donor/get-all-donors

get /admin/all_donors



# Get donor card details
Source: https://api-docs.helpyousponsor.com/api-reference/donor/get-donor-card-details

get /admin/donor-credit-card/{donor_id}



# Get donor form fields
Source: https://api-docs.helpyousponsor.com/api-reference/donor/get-donor-form-fields

get /admin/donor/{hysform_id}



# Get PayPal credentials
Source: https://api-docs.helpyousponsor.com/api-reference/donor/get-paypal-credentials

get /donor/paypal



# Select a saved donor report
Source: https://api-docs.helpyousponsor.com/api-reference/donor/select-a-saved-donor-report

post /admin/donor/view/{report_id}/{hysform_id}/{trashed}



# Send notification to donors
Source: https://api-docs.helpyousponsor.com/api-reference/donor/send-notification-to-donors

post /admin/donors/notify



# Send signup email to a donor
Source: https://api-docs.helpyousponsor.com/api-reference/donor/send-signup-email-to-a-donor

get /admin/donor/{commitment_id}/email



# Send year end statements to donors
Source: https://api-docs.helpyousponsor.com/api-reference/donor/send-year-end-statements-to-donors

post /admin/donors/send_year_end



# Update donor credit card details
Source: https://api-docs.helpyousponsor.com/api-reference/donor/update-donor-credit-card-details

post /admin/donor-credit-card/{donor_id}



# Update donor PayPal credentials
Source: https://api-docs.helpyousponsor.com/api-reference/donor/update-donor-paypal-credentials

post /donor/{donor_id}/paypal



# Activate donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/activate-donors

post /admin/donors/activate



# Archive donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/archive-donors

post /admin/donors/archive



# Delete donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/delete-donors

delete /admin/delete/donors



# Get all donor forms by client id
Source: https://api-docs.helpyousponsor.com/api-reference/donors/get-all-donor-forms-by-client-id

get /donors/{client_id}/forms



# Get all donors with pagination, search and sort
Source: https://api-docs.helpyousponsor.com/api-reference/donors/get-all-donors-with-pagination-search-and-sort

get /admin/donors/{hysform_id}



# Get field options for donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/get-field-options-for-donors

get /admin/donors/{hysform_id}/fields/{type}



# Get statistics of donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/get-statistics-of-donors

get /admin/statistics/donors



# Post field options for donors
Source: https://api-docs.helpyousponsor.com/api-reference/donors/post-field-options-for-donors

post /admin/donor/field_options



# Remove a saved donor view
Source: https://api-docs.helpyousponsor.com/api-reference/donors/remove-a-saved-donor-view

delete /admin/donor/view/{report_id}/{hysform_id}



# Approve a draft message
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/approve-a-draft-message

post /admin/message/draft/{email_id}/approve



# Assign an email to an admin
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/assign-an-email-to-an-admin

put /admin/email/assign_admin



# Assign multiple emails to an admin
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/assign-multiple-emails-to-an-admin

put /admin/emails/assign_admin



# Create a draft message
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/create-a-draft-message

post /admin/message/draft/{entity_id}/{donor_id}/{from}/{file_id}



# Get all admins
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/get-all-admins

get /admin/email_manager/admins



# Get available entities
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/get-available-entities

get /admin/email_manager/entities



# Get sponsors of an entity
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/get-sponsors-of-an-entity

get /admin/email_manager/entities/{id}/sponsors



# Send a message
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/send-a-message

get /admin/message/send/{entity_id}/{donor_id}/{from}/{file_id}



# Send an email response
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/send-an-email-response

post /admin/email/response



# Update the status of an email
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/update-the-status-of-an-email

put /admin/email/status/{email_id}/update



# Update the status of multiple emails
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/update-the-status-of-multiple-emails

put /admin/emails/status/{mail_status}/update



# View a specific email
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/view-a-specific-email

get /admin/emails/{email_id}



# View all admin emails
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/view-all-admin-emails

post /admin/email_manager/admin/{id}/emails



# View email manager
Source: https://api-docs.helpyousponsor.com/api-reference/email-manager/view-email-manager

post /admin/email_manager



# Get email settings
Source: https://api-docs.helpyousponsor.com/api-reference/email-settings/get-email-settings

get /admin/email/settings



# Post email settings
Source: https://api-docs.helpyousponsor.com/api-reference/email-settings/post-email-settings

post /admin/email/settings



# Activate Entity
Source: https://api-docs.helpyousponsor.com/api-reference/entities/activate-entity

get /admin/entity/{entity_id}/activate
Handles the activation (restoration) of an archived entity based on the provided entity ID.



# Activate Multiple Entities
Source: https://api-docs.helpyousponsor.com/api-reference/entities/activate-multiple-entities

post /admin/entities/{program_id}/activate
Handles the activation (restoration) of multiple archived entities within a specific program.



# Add New Entity
Source: https://api-docs.helpyousponsor.com/api-reference/entities/add-new-entity

post /admin/entity/{program_id}
Posts data to add a new entity based on the provided program ID.



# Archive Entities
Source: https://api-docs.helpyousponsor.com/api-reference/entities/archive-entities

delete /admin/entities/{program_id}
Handles the removal (archival) of one or multiple entities,
     *          including archival of sponsorships, removal of commitments, and updates to the cache.



# Archive Entity
Source: https://api-docs.helpyousponsor.com/api-reference/entities/archive-entity

delete /admin/entity/{entity_id}
Handles the removal (archival) of an entity based on the provided entity ID.



# Get program recipient form
Source: https://api-docs.helpyousponsor.com/api-reference/entities/get-program-recipient-form

get /admin/entity/{program_id}
Gets the program recipient form based on the provided program ID and client information.



# Permanently delete an entity
Source: https://api-docs.helpyousponsor.com/api-reference/entities/permanently-delete-an-entity

delete /admin/entity/{entity_id}/delete



# Permanently delete entities
Source: https://api-docs.helpyousponsor.com/api-reference/entities/permanently-delete-entities

delete /admin/entities/{program_id}/delete



# Post Edit Entity
Source: https://api-docs.helpyousponsor.com/api-reference/entities/post-edit-entity

put /admin/program/entity
Handles the submission of edited entity data,
     *          including updating various fields and maintaining archival status if applicable.



# Post Edit Multiple Entities
Source: https://api-docs.helpyousponsor.com/api-reference/entities/post-edit-multiple-entities

patch /admin/program/entities
Handles the submission of edited data for multiple entities,
     *          including updating various fields and maintaining archival status if applicable.



# Show All Entities for a specific program
Source: https://api-docs.helpyousponsor.com/api-reference/entities/show-all-entities-for-a-specific-program

get /admin/entities/{program_id}
Shows all entities for a given program ID,
     *          with various filtering, sorting, and pagination options.



# View Entity Details
Source: https://api-docs.helpyousponsor.com/api-reference/entities/view-entity-details

get /admin/program/entities/{id}
Retrieves details of an entity for editing,
     *          including its profile, fields, sponsors, donations, and more.



# Delete a file
Source: https://api-docs.helpyousponsor.com/api-reference/files/delete-a-file

delete /file/{id}



# Edit a file
Source: https://api-docs.helpyousponsor.com/api-reference/files/edit-a-file

put /file/{id}



# Get file details
Source: https://api-docs.helpyousponsor.com/api-reference/files/get-file-details

get /file/{id}



# Get files table
Source: https://api-docs.helpyousponsor.com/api-reference/files/get-files-table

get /files/{type}/{id}/table



# Import CSV for a specific program
Source: https://api-docs.helpyousponsor.com/api-reference/files/import-csv-for-a-specific-program

get /csv_import/{program_id}



# Import CSV for a specific program
Source: https://api-docs.helpyousponsor.com/api-reference/files/import-csv-for-a-specific-program-1

post /csv_import/{program_id}



# Make placeholder picture
Source: https://api-docs.helpyousponsor.com/api-reference/files/make-placeholder-picture

get /picture/{id}/placeholder



# Make profile picture
Source: https://api-docs.helpyousponsor.com/api-reference/files/make-profile-picture

get /picture/{id}/profile



# Post a record upload
Source: https://api-docs.helpyousponsor.com/api-reference/files/post-a-record-upload

post /admin/recordUpload



# Process the import job for donors and recipients
Source: https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-donors-and-recipients

post /csv_process/{program_id}



# Process the import job for payments
Source: https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-payments

post /csv_process/{program_id}/payments



# Process the import job for sponsorship relationships
Source: https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-sponsorship-relationships

post /csv_process/{program_id}/relationships



# Rotate picture
Source: https://api-docs.helpyousponsor.com/api-reference/files/rotate-picture

get /picture/{id}/rotate



# Upload a file
Source: https://api-docs.helpyousponsor.com/api-reference/files/upload-a-file

get /file/{type}/{id}/upload



# Upload a file
Source: https://api-docs.helpyousponsor.com/api-reference/files/upload-a-file-1

post /file/{type}/{id}/upload



# Delete a file
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/delete-a-file

delete /frontend/donor/dashboard/file/{client_id}/{program_id}/{id}/{entity_id}/{session_id}



# Donor Credit Card Information
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-credit-card-information

get /frontend/donor/dashboard/card/{client_id}/{program_id}/{session_id}
Allows a donor to update their credit card information.



# Donor View
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view

get /frontend/donor/dashboard/{client_id}/{program_id}/{session_id}
Displays the donor's profile and related information,
     *          handling the retrieval of donor data based on session ID.



# Donor View Entity
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view-entity

get /frontend/donor/dashboard/entity/{client_id}/{program_id}/{entity_id}/{session_id}
Displays a specific entity's profile and related information to the donor.



# Donor View Entity Message History
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view-entity-message-history

get /frontend/donor/dashboard/entity/messages/{client_id}/{program_id}/{entity_id}/{session_id}
Returns message history for a specific donor entity.



# Get Donor Information
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/get-donor-information

get /frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id}
Allows a donor to get their information.



# Get files for a donor
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/get-files-for-a-donor

get /frontend/donor/dashboard/files/{client_id}/{program_id}/{id}/{entity_id}/{session_id}



# Handle Donor File Uploads
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/handle-donor-file-uploads

get /frontend/donor/dashboard/uploads/{client_id}/{program_id}/{entity_id}/{session_id}



# Post Donor View Entity Message
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/post-donor-view-entity-message

post /frontend/donor/dashboard/entity/compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id}
Allows a donor to send a message to an entity.



# Save file upload to database
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/save-file-upload-to-database

post /frontend/donor/recordUpload/{client_id}/{session_id}



# Update Donor Information
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/update-donor-information

put /frontend/donor/dashboard/details/{client_id}/{program_id}/{session_id}
Allows a donor to update their information.



# Update Donor's Credit Card Information
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/update-donors-credit-card-information

post /frontend/donor/dashboard/card/{client_id}/{program_id}/{session_id}



# Uploads a file for a donor
Source: https://api-docs.helpyousponsor.com/api-reference/frontend-donor/uploads-a-file-for-a-donor

post /frontend/donor/dashboard/upload/{client_id}/{program_id}/{entity_id}/{session_id}



# Add a designation to the checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/add-a-designation-to-the-checkout

post /frontend/checkout/designation/{client_id}/{program_id}/{currency}/{session_id}



# Checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/checkout

get /frontend/order/{client_id}/{program_id}/{session_id}
Order to sponsor an entity



# Create a new donor and process their donation
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/create-a-new-donor-and-process-their-donation

post /frontend/checkout/signup/{client_id}/{program_id}/{session_id}



# Display titles and files with pagination
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/display-titles-and-files-with-pagination

get /frontend/entities/all/{client_id}/{program_id}/{session_id}



# Forgot Username
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/forgot-username

get /frontend/forgot_username/{client_id}/{program_id}/{session_id}
Handles the process for users who have forgotten their username by initiating a new session.



# Get Login Information
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/get-login-information

get /frontend/login/{client_id}/{program_id}/{session_id}
Retrieves login information and related details for a specific client and program.



# Handle the checkout process for sponsorships
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/handle-the-checkout-process-for-sponsorships

get /frontend/order/sponsorships/{client_id}/{program_id}/{session_id}



# Login a donor and process their donation
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/login-a-donor-and-process-their-donation

post /frontend/checkout/login/{client_id}/{program_id}/{session_id}



# Post Forgot Username
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/post-forgot-username

post /frontend/forgot_username/{client_id}/{program_id}/{session_id}
Handles the process for users who have forgotten their username
     *          by verifying the email and sending the username to the user.



# Post Login
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/post-login

post /frontend/login/{client_id}/{program_id}/{session_id}
Handles the login process for a user, including validation and authentication.



# Post Logout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/post-logout

get /frontend/logout/{client_id}/{program_id}/{session_id}
Handles user logout by terminating the session and clearing related data.



# Post Reset Password
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/post-reset-password

post /frontend/reset_password/{client_id}/{program_id}/{session_id}
Handles the password reset process including
     *          verification and sending a temporary password to the user.



# Process a campaign checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/process-a-campaign-checkout

post /frontend/checkout/campaign/{client_id}/{program_id}/{session_id}



# Remove a designation from the checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/remove-a-designation-from-the-checkout

delete /frontend/checkout/designation/{client_id}/{program_id}/{id}/{currency}/{session_id}



# Remove an entity from the checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/remove-an-entity-from-the-checkout

delete /frontend/checkout/entity/{client_id}/{program_id}/{entity_id}/{session_id}



# Reset Password
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/reset-password

get /frontend/reset_password/{client_id}/{program_id}/{session_id}
Initiates a password reset process by generating a new session and returning session details.



# Save an entity
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/save-an-entity

post /frontend/entity/save/{client_id}/{program_id}/{entity_id}/{session_id}
Saves an entity with the given details



# Update the amount for a specific entity in the checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-amount-for-a-specific-entity-in-the-checkout

put /frontend/checkout/amount/{client_id}/{program_id}/{entity_id}/{amount}/{currency}/{session_id}



# Update the frequency for a specific designation in the checkout
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-frequency-for-a-specific-designation-in-the-checkout

put /frontend/checkout/designation/frequency/{client_id}/{program_id}/{designation_id}/{frequency}/{session_id}



# Update the frequency of a donation
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-frequency-of-a-donation

put /frontend/checkout/frequency/{client_id}/{program_id}/{entity_id}/{frequency}/{session_id}



# View a random entity
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/view-a-random-entity

get /frontend/entities/random/{client_id}/{program_id}
Returns a random entity from a specific client and program



# View entity details
Source: https://api-docs.helpyousponsor.com/api-reference/frontend/view-entity-details

get /frontend/entity/{client_id}/{program_id}/{entity_id}/{session_id}



# Add a donor form to a program
Source: https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-donor-form-to-a-program

post /admin/program/form/donor



# Add a sponsorship form to a program
Source: https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-sponsorship-form-to-a-program

post /admin/program/form/sponsorship



# Add a submit form to a program
Source: https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-submit-form-to-a-program

post /admin/program/form



# Attach an email set to a program
Source: https://api-docs.helpyousponsor.com/api-reference/manage-program/attach-an-email-set-to-a-program

post /admin/program/emailset



# Attach settings to a program
Source: https://api-docs.helpyousponsor.com/api-reference/manage-program/attach-settings-to-a-program

post /admin/program/settings



# Create a new note
Source: https://api-docs.helpyousponsor.com/api-reference/notes/create-a-new-note

post /admin/notes/{type}/{program_id}



# Edit a note
Source: https://api-docs.helpyousponsor.com/api-reference/notes/edit-a-note

put /admin/notes/{note_id}/{program_id}



# Get note details
Source: https://api-docs.helpyousponsor.com/api-reference/notes/get-note-details

get /admin/notes/{note_id}/{program_id}



# View notes
Source: https://api-docs.helpyousponsor.com/api-reference/notes/view-notes

post /admin/notes



# Add a form field
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/add-a-form-field

post /admin/form/field/{id}/{type}
Add a new field to a form



# Create a new form
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/create-a-new-form

post /admin/forms



# Delete a form
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/delete-a-form

delete /admin/forms/{hysform_id}
Delete a form by its id



# Delete a form field
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/delete-a-form-field

delete /admin/form/field
Delete an existing field in a form



# Edit a form field
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/edit-a-form-field

put /admin/form/field
Edit an existing field in a form



# Form Details
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/form-details

get /admin/forms/{hysform_id}
Form Details



# Form field types
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/form-field-types

get /admin/form/field/{id}/{type}



# Get all forms
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/get-all-forms

get /admin/forms
Returns a list of all forms for a specific client



# Manage a form
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/manage-a-form

get /admin/forms/{hysform_id}/manage



# Update a form
Source: https://api-docs.helpyousponsor.com/api-reference/program-forms/update-a-form

put /admin/forms/{hysform_id}
Update a form



# Create a child program
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/create-a-child-program

post /admin/program



# Create a sub program
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/create-a-sub-program

post /admin/program/sub_program



# Get campaign program details
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/get-campaign-program-details

get /program/{id}/campaign



# Get details of a specific program
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/get-details-of-a-specific-program

get /program/{id}



# Get program settings
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/get-program-settings

get /program/{id}/settings



# Manage programs
Source: https://api-docs.helpyousponsor.com/api-reference/program-options/manage-programs

get /programs



# Edit a program
Source: https://api-docs.helpyousponsor.com/api-reference/programs/edit-a-program

put /program/{program_id}



# Entity table headers
Source: https://api-docs.helpyousponsor.com/api-reference/programs/entity-table-headers

get /admin/entities/{program_id}/headers/{trashed}



# Get Detailed Field Options
Source: https://api-docs.helpyousponsor.com/api-reference/programs/get-detailed-field-options

get /admin/fields/options/{program_id}/{type}
Retrieves detailed field options for a specific program and type,
     *          including program information, fields, reports, and details.



# Get Program Statistics
Source: https://api-docs.helpyousponsor.com/api-reference/programs/get-program-statistics

get /admin/program/{program_id}/statistics
Retrieves statistical data for a specific program based on the provided program ID.



# Move and entity to a different program
Source: https://api-docs.helpyousponsor.com/api-reference/programs/move-and-entity-to-a-different-program

post /admin/move/{entity_id}
Handles the process of moving an entity to a different program,
     *          including updating entity records and clearing relevant caches.



# Move Multiple Entities
Source: https://api-docs.helpyousponsor.com/api-reference/programs/move-multiple-entities

put /admin/entities/move
Handles the process of moving multiple entities to a different program,
     *          including updating entity records and clearing relevant caches.



# Post Field Options
Source: https://api-docs.helpyousponsor.com/api-reference/programs/post-field-options

post /admin/fields/options/{program_id}/{type}
Saves field options for a specific program, and optionally, a specific type.
     *          This includes saving preferences in Redis and handling report saving.



# Remove a program
Source: https://api-docs.helpyousponsor.com/api-reference/programs/remove-a-program

delete /admin/program/{program_id}



# Remove a saved view
Source: https://api-docs.helpyousponsor.com/api-reference/programs/remove-a-saved-view

delete /admin/view/{report_id}/{program_id}



# Select Saved View
Source: https://api-docs.helpyousponsor.com/api-reference/programs/select-saved-view

get /admin/programs/view/{report_id}/{program_id}/{trashed}
Handles the selection of a saved report,
     *          updating admin preferences in Redis and clearing relevant caches.



# View compatible programs when moving entities
Source: https://api-docs.helpyousponsor.com/api-reference/programs/view-compatible-programs-when-moving-entities

get /admin/move/{entity_id}/compatible_programs
Moves an entity to a different program,
     *          retrieves necessary details for the move operation including compatible programs,
     *          entity details, and more.



# List programs and forms
Source: https://api-docs.helpyousponsor.com/api-reference/progress-reports/list-programs-and-forms

get /admin/progress_report



# Post progress report
Source: https://api-docs.helpyousponsor.com/api-reference/progress-reports/post-progress-report

post /admin/progress_report



# Add new setting
Source: https://api-docs.helpyousponsor.com/api-reference/settings/add-new-setting

post /admin/settings



# Delete a setting
Source: https://api-docs.helpyousponsor.com/api-reference/settings/delete-a-setting

delete /admin/settings/{settings_id}



# Edit a setting
Source: https://api-docs.helpyousponsor.com/api-reference/settings/edit-a-setting

put /admin/settings/{settings_id}



# Get all settings
Source: https://api-docs.helpyousponsor.com/api-reference/settings/get-all-settings

get /admin/settings



# Get details for a setting
Source: https://api-docs.helpyousponsor.com/api-reference/settings/get-details-for-a-setting

get /admin/settings/{settings_id}



# Get details for campaign settings
Source: https://api-docs.helpyousponsor.com/api-reference/settings/get-details-for-campaign-settings

get /admin/campaign/settings/{settings_id}



# Add a new sponsorship
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/add-a-new-sponsorship

post /admin/sponsorships



# Archive a sponsorship for a donor
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/archive-a-sponsorship-for-a-donor

post /admin/sponsorships/{donor_entity_id}/archive



# Archive Sponsorships for Donors
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/archive-sponsorships-for-donors

post /admin/sponsorships/archive



# Donors and Available Entities
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/donors-and-available-entities

get /admin/sponsorships/new
Returns donors and available entities



# Get Sponsorship Statistics
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorship-statistics

get /admin/sponsorships/statistics
Retrieves statistics related to sponsorships for a given client.



# Get sponsorships for a specific donor
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorships-for-a-specific-donor

get /admin/donor/{id}/sponsorships
Returns sponsorships data



# Get Sponsorships Table Headers
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorships-table-headers

post /admin/sponsorships/{program_id}/headers
Retrieves data for the sponsored table based on the given program ID, client ID, and filter.



# Post Sponsorships Next
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/post-sponsorships-next

post /admin/sponsorships/donor
Returns donor details, program details, and other related information



# Restore a sponsorship for a donor
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/restore-a-sponsorship-for-a-donor

post /admin/sponsorships/{donor_entity_id}/restore



# Show All Sponsorships
Source: https://api-docs.helpyousponsor.com/api-reference/sponsorships/show-all-sponsorships

get /admin/sponsorships/{program_id}
Shows all sponsorships for a given program ID,
     *          with various filtering, sorting, and pagination options.



# Post Template
Source: https://api-docs.helpyousponsor.com/api-reference/templates/post-template

post /admin/template
Handles saving or updating a template with provided CSS,
     *          JavaScript, and HTML content based on the client ID.



# Retrieve Template
Source: https://api-docs.helpyousponsor.com/api-reference/templates/retrieve-template

get /admin/template
Fetches a specific template and associated pictures based on the client ID.



# Activate User
Source: https://api-docs.helpyousponsor.com/api-reference/user/activate-user

post /user/email/verification
Handles the activation of a user based on the provided user ID and activation code.



# Check User Activation Status
Source: https://api-docs.helpyousponsor.com/api-reference/user/check-user-activation-status

get /user/{id}/activation/status
Checks the activation status of a user based on the user ID.



# Send Verification Email
Source: https://api-docs.helpyousponsor.com/api-reference/user/send-verification-email

post /user/{id}/send_verification_email
Sends a verification email to the user with the given ID.



# User Login
Source: https://api-docs.helpyousponsor.com/api-reference/user/user-login

post /login
Handles user login.



# User Logout
Source: https://api-docs.helpyousponsor.com/api-reference/user/user-logout

get /logout
Handles user logout process including session termination and client logout status update.



# Check calculation status for wrapped statistics
Source: https://api-docs.helpyousponsor.com/api-reference/wrapped/check-calculation-status-for-wrapped-statistics

get /admin/wrapped/{year}/status



# Get organization's year in review
Source: https://api-docs.helpyousponsor.com/api-reference/wrapped/get-organizations-year-in-review

get /admin/wrapped/{year}
Retrieves wrapped statistics for a given year. For large datasets (>10,000 donations)



# HelpYouSponsor API Documentation
Source: https://api-docs.helpyousponsor.com/introduction

Welcome to the HelpYouSponsor API Documentation. This comprehensive guide provides detailed information on how to interact with the HelpYouSponsor API, enabling developers to seamlessly integrate and manage various functionalities of HelpYouSponsor within their applications. Our API offers robust endpoints for user management, client interactions, email settings, donation tracking, and more.

### Overview

The HelpYouSponsor API is designed to handle a wide range of tasks that are essential for managing a Non-Profit Organization. From donation tracking to sponsorship automation, this API provides all the necessary endpoints to streamline your workflow and enhance the functionality of your Non-Profit.

### Key Features

1. **Donor Management**: Manage donor accounts, monitor their sponsorships and donations, and update donor information.
2. **Sponsorship Management**: Automated sponsor-recipient matching, multi-program support, and customizable sponsorship levels and durations.
3. **Data Management**: Access to centralized donor and recipient database, advanced search and filtering capabilities.
4. **Donation Tracking**: Monitor donations, manage donor information, and generate reports on donation activities.

### Getting Started

To get started, generate an API key and include it in the header of every request. The API supports multiple programming languages and provides sample code for each endpoint to help you integrate quickly.

### Authentication

Generate an API key from **Settings → Account Settings → Developer Settings** in the HelpYouSponsor dashboard. Include it in the `X-HYS-API-Key` header of every request.

```sh theme={null}
curl --request GET \
--url https://api.helpyousponsor.com/v1/admin/donors \
--header 'X-HYS-API-Key: hys_your_key_here'
```

API keys can be given a name and an optional expiration date. The full key is only shown once at creation time — store it securely. You can revoke a key at any time from Developer Settings.

## Response Codes

Our API utilizes standard HTTP status codes to indicate the success or failure of a request:

1. **200**: Successful request.
2. **401**: Unauthorized access.
3. **500**: Internal server error.

### Conclusion

The HelpYouSponsor API is a powerful tool designed to enhance your Non-profits functionality. By following this documentation, you will be able to integrate our API seamlessly and leverage its features to improve your platform's efficiency and user experience. If you have any questions or need further assistance, please refer to our support page or contact our technical team.