# HelpYouSponsor Docs ## Docs - [HelpYouSponsor API Documentation](https://api-docs.helpyousponsor.com/introduction.md): 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 en… - [User Login](https://api-docs.helpyousponsor.com/api-reference/user/user-login.md): Handles user login. - [User Logout](https://api-docs.helpyousponsor.com/api-reference/user/user-logout.md): Handles user logout process including session termination and client logout status update. - [Activate User](https://api-docs.helpyousponsor.com/api-reference/user/activate-user.md): Handles the activation of a user based on the provided user ID and activation code. - [Check User Activation Status](https://api-docs.helpyousponsor.com/api-reference/user/check-user-activation-status.md): Checks the activation status of a user based on the user ID. - [Send Verification Email](https://api-docs.helpyousponsor.com/api-reference/user/send-verification-email.md): Sends a verification email to the user with the given ID. - [Client payment](https://api-docs.helpyousponsor.com/api-reference/client/client-payment.md) - [Edit client account](https://api-docs.helpyousponsor.com/api-reference/client/edit-client-account.md) - [Edit client integration](https://api-docs.helpyousponsor.com/api-reference/client/edit-client-integration.md) - [Get client card details](https://api-docs.helpyousponsor.com/api-reference/client/get-client-card-details.md) - [Get client payment status](https://api-docs.helpyousponsor.com/api-reference/client/get-client-payment-status.md) - [Get client payments](https://api-docs.helpyousponsor.com/api-reference/client/get-client-payments.md) - [Get details of an integration](https://api-docs.helpyousponsor.com/api-reference/client/get-details-of-an-integration.md) - [Get price for client to pay](https://api-docs.helpyousponsor.com/api-reference/client/get-price-for-client-to-pay.md) - [Update client credit card](https://api-docs.helpyousponsor.com/api-reference/client/update-client-credit-card.md) - [View Integrations](https://api-docs.helpyousponsor.com/api-reference/client/view-integrations.md) - [Get email settings](https://api-docs.helpyousponsor.com/api-reference/email-settings/get-email-settings.md) - [Post email settings](https://api-docs.helpyousponsor.com/api-reference/email-settings/post-email-settings.md) - [Edit a commitment](https://api-docs.helpyousponsor.com/api-reference/commitments/edit-a-commitment.md) - [Edit multiple commitments](https://api-docs.helpyousponsor.com/api-reference/commitments/edit-multiple-commitments.md) - [Get commitments graph](https://api-docs.helpyousponsor.com/api-reference/commitments/get-commitments-graph.md) - [Get Dashboard Data](https://api-docs.helpyousponsor.com/api-reference/admin-dashboard/get-dashboard-data.md) - [Add a new designation](https://api-docs.helpyousponsor.com/api-reference/designation/add-a-new-designation.md) - [Designation Details](https://api-docs.helpyousponsor.com/api-reference/designation/designation-details.md) - [Edit a designation](https://api-docs.helpyousponsor.com/api-reference/designation/edit-a-designation.md) - [Remove a designation](https://api-docs.helpyousponsor.com/api-reference/designation/remove-a-designation.md) - [View all designations](https://api-docs.helpyousponsor.com/api-reference/designation/view-all-designations.md) - [List emailsets and program forms when creating a designation](https://api-docs.helpyousponsor.com/api-reference/designation/list-emailsets-and-program-forms-when-creating-a-designation.md) - [Add a commitment donation](https://api-docs.helpyousponsor.com/api-reference/donations/add-a-commitment-donation.md) - [Add a new donation](https://api-docs.helpyousponsor.com/api-reference/donations/add-a-new-donation.md) - [Ccommitment details](https://api-docs.helpyousponsor.com/api-reference/donations/ccommitment-details.md) - [Donation details](https://api-docs.helpyousponsor.com/api-reference/donations/donation-details.md) - [Donation view options](https://api-docs.helpyousponsor.com/api-reference/donations/donation-view-options.md) - [Edit a donation](https://api-docs.helpyousponsor.com/api-reference/donations/edit-a-donation.md) - [Get all donations by a specific donor](https://api-docs.helpyousponsor.com/api-reference/donations/get-all-donations-by-a-specific-donor.md) - [Get all donations by donors](https://api-docs.helpyousponsor.com/api-reference/donations/get-all-donations-by-donors.md) - [Get donations graph](https://api-docs.helpyousponsor.com/api-reference/donations/get-donations-graph.md) - [Get form fields for a specific donor group](https://api-docs.helpyousponsor.com/api-reference/donations/get-form-fields-for-a-specific-donor-group.md) - [Refund a donation](https://api-docs.helpyousponsor.com/api-reference/donations/refund-a-donation.md) - [Remove a donation](https://api-docs.helpyousponsor.com/api-reference/donations/remove-a-donation.md) - [View all donations](https://api-docs.helpyousponsor.com/api-reference/donations/view-all-donations.md) - [Add a new donor](https://api-docs.helpyousponsor.com/api-reference/donor/add-a-new-donor.md) - [Donors table headers](https://api-docs.helpyousponsor.com/api-reference/donor/donors-table-headers.md) - [Edit a donor](https://api-docs.helpyousponsor.com/api-reference/donor/edit-a-donor.md) - [Get a donor](https://api-docs.helpyousponsor.com/api-reference/donor/get-a-donor.md) - [Get all donors](https://api-docs.helpyousponsor.com/api-reference/donor/get-all-donors.md) - [Get donor form fields](https://api-docs.helpyousponsor.com/api-reference/donor/get-donor-form-fields.md) - [Get PayPal credentials](https://api-docs.helpyousponsor.com/api-reference/donor/get-paypal-credentials.md) - [Send notification to donors](https://api-docs.helpyousponsor.com/api-reference/donor/send-notification-to-donors.md) - [Send signup email to a donor](https://api-docs.helpyousponsor.com/api-reference/donor/send-signup-email-to-a-donor.md) - [Send year end statements to donors](https://api-docs.helpyousponsor.com/api-reference/donor/send-year-end-statements-to-donors.md) - [Update donor PayPal credentials](https://api-docs.helpyousponsor.com/api-reference/donor/update-donor-paypal-credentials.md) - [Delete donor card details](https://api-docs.helpyousponsor.com/api-reference/donor/delete-donor-card-details.md) - [Get donor card details](https://api-docs.helpyousponsor.com/api-reference/donor/get-donor-card-details.md) - [Select a saved donor report](https://api-docs.helpyousponsor.com/api-reference/donor/select-a-saved-donor-report.md) - [Update donor credit card details](https://api-docs.helpyousponsor.com/api-reference/donor/update-donor-credit-card-details.md) - [Activate donors](https://api-docs.helpyousponsor.com/api-reference/donors/activate-donors.md) - [Archive donors](https://api-docs.helpyousponsor.com/api-reference/donors/archive-donors.md) - [Get all donor forms by client id](https://api-docs.helpyousponsor.com/api-reference/donors/get-all-donor-forms-by-client-id.md) - [Get all donors with pagination, search and sort](https://api-docs.helpyousponsor.com/api-reference/donors/get-all-donors-with-pagination-search-and-sort.md) - [Get field options for donors](https://api-docs.helpyousponsor.com/api-reference/donors/get-field-options-for-donors.md) - [Get statistics of donors](https://api-docs.helpyousponsor.com/api-reference/donors/get-statistics-of-donors.md) - [Post field options for donors](https://api-docs.helpyousponsor.com/api-reference/donors/post-field-options-for-donors.md) - [Remove a saved donor view](https://api-docs.helpyousponsor.com/api-reference/donors/remove-a-saved-donor-view.md) - [Delete donors](https://api-docs.helpyousponsor.com/api-reference/donors/delete-donors.md) - [Add a new sponsorship](https://api-docs.helpyousponsor.com/api-reference/sponsorships/add-a-new-sponsorship.md) - [Archive a sponsorship for a donor](https://api-docs.helpyousponsor.com/api-reference/sponsorships/archive-a-sponsorship-for-a-donor.md) - [Archive Sponsorships for Donors](https://api-docs.helpyousponsor.com/api-reference/sponsorships/archive-sponsorships-for-donors.md) - [Donors and Available Entities](https://api-docs.helpyousponsor.com/api-reference/sponsorships/donors-and-available-entities.md): Returns donors and available entities - [Get Sponsorship Statistics](https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorship-statistics.md): Retrieves statistics related to sponsorships for a given client. - [Get sponsorships for a specific donor](https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorships-for-a-specific-donor.md): Returns sponsorships data - [Get Sponsorships Table Headers](https://api-docs.helpyousponsor.com/api-reference/sponsorships/get-sponsorships-table-headers.md): Retrieves data for the sponsored table based on the given program ID, client ID, and filter. - [Post Sponsorships Next](https://api-docs.helpyousponsor.com/api-reference/sponsorships/post-sponsorships-next.md): Returns donor details, program details, and other related information - [Restore a sponsorship for a donor](https://api-docs.helpyousponsor.com/api-reference/sponsorships/restore-a-sponsorship-for-a-donor.md) - [Show All Sponsorships](https://api-docs.helpyousponsor.com/api-reference/sponsorships/show-all-sponsorships.md): Shows all sponsorships for a given program ID, * with various filtering, sorting, and pagination options. - [Approve a draft message](https://api-docs.helpyousponsor.com/api-reference/email-manager/approve-a-draft-message.md) - [Assign an email to an admin](https://api-docs.helpyousponsor.com/api-reference/email-manager/assign-an-email-to-an-admin.md) - [Get all admins](https://api-docs.helpyousponsor.com/api-reference/email-manager/get-all-admins.md) - [Get available entities](https://api-docs.helpyousponsor.com/api-reference/email-manager/get-available-entities.md) - [Get sponsors of an entity](https://api-docs.helpyousponsor.com/api-reference/email-manager/get-sponsors-of-an-entity.md) - [Send an email response](https://api-docs.helpyousponsor.com/api-reference/email-manager/send-an-email-response.md) - [Update the status of an email](https://api-docs.helpyousponsor.com/api-reference/email-manager/update-the-status-of-an-email.md) - [Update the status of multiple emails](https://api-docs.helpyousponsor.com/api-reference/email-manager/update-the-status-of-multiple-emails.md) - [View a specific email](https://api-docs.helpyousponsor.com/api-reference/email-manager/view-a-specific-email.md) - [View email manager](https://api-docs.helpyousponsor.com/api-reference/email-manager/view-email-manager.md) - [Assign multiple emails to an admin](https://api-docs.helpyousponsor.com/api-reference/email-manager/assign-multiple-emails-to-an-admin.md) - [Create a draft message](https://api-docs.helpyousponsor.com/api-reference/email-manager/create-a-draft-message.md) - [Send a message](https://api-docs.helpyousponsor.com/api-reference/email-manager/send-a-message.md) - [View all admin emails](https://api-docs.helpyousponsor.com/api-reference/email-manager/view-all-admin-emails.md) - [Add a new email set](https://api-docs.helpyousponsor.com/api-reference/auto-emails/add-a-new-email-set.md) - [Edit an email set](https://api-docs.helpyousponsor.com/api-reference/auto-emails/edit-an-email-set.md) - [Edit an email template](https://api-docs.helpyousponsor.com/api-reference/auto-emails/edit-an-email-template.md) - [Get details of an emailset](https://api-docs.helpyousponsor.com/api-reference/auto-emails/get-details-of-an-emailset.md) - [Manage auto emails](https://api-docs.helpyousponsor.com/api-reference/auto-emails/manage-auto-emails.md) - [Remove an email set](https://api-docs.helpyousponsor.com/api-reference/auto-emails/remove-an-email-set.md) - [Send an email](https://api-docs.helpyousponsor.com/api-reference/auto-emails/send-an-email.md) - [Activate Entity](https://api-docs.helpyousponsor.com/api-reference/entities/activate-entity.md): Handles the activation (restoration) of an archived entity based on the provided entity ID. - [Activate Multiple Entities](https://api-docs.helpyousponsor.com/api-reference/entities/activate-multiple-entities.md): Handles the activation (restoration) of multiple archived entities within a specific program. - [Add New Entity](https://api-docs.helpyousponsor.com/api-reference/entities/add-new-entity.md): Posts data to add a new entity based on the provided program ID. - [Archive Entity](https://api-docs.helpyousponsor.com/api-reference/entities/archive-entity.md): Handles the removal (archival) of an entity based on the provided entity ID. - [Get program recipient form](https://api-docs.helpyousponsor.com/api-reference/entities/get-program-recipient-form.md): Gets the program recipient form based on the provided program ID and client information. - [Permanently delete an entity](https://api-docs.helpyousponsor.com/api-reference/entities/permanently-delete-an-entity.md) - [Post Edit Entity](https://api-docs.helpyousponsor.com/api-reference/entities/post-edit-entity.md): Handles the submission of edited entity data, * including updating various fields and maintaining archival status if applicable. - [Post Edit Multiple Entities](https://api-docs.helpyousponsor.com/api-reference/entities/post-edit-multiple-entities.md): 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](https://api-docs.helpyousponsor.com/api-reference/entities/show-all-entities-for-a-specific-program.md): Shows all entities for a given program ID, * with various filtering, sorting, and pagination options. - [View Entity Details](https://api-docs.helpyousponsor.com/api-reference/entities/view-entity-details.md): Retrieves details of an entity for editing, * including its profile, fields, sponsors, donations, and more. - [Archive Entities](https://api-docs.helpyousponsor.com/api-reference/entities/archive-entities.md): Handles the removal (archival) of one or multiple entities, * including archival of sponsorships, removal of commitments, and updates to the cache. - [Permanently delete entities](https://api-docs.helpyousponsor.com/api-reference/entities/permanently-delete-entities.md) - [Edit a program](https://api-docs.helpyousponsor.com/api-reference/programs/edit-a-program.md) - [Get Detailed Field Options](https://api-docs.helpyousponsor.com/api-reference/programs/get-detailed-field-options.md): Retrieves detailed field options for a specific program and type, * including program information, fields, reports, and details. - [Get Program Statistics](https://api-docs.helpyousponsor.com/api-reference/programs/get-program-statistics.md): Retrieves statistical data for a specific program based on the provided program ID. - [Move and entity to a different program](https://api-docs.helpyousponsor.com/api-reference/programs/move-and-entity-to-a-different-program.md): Handles the process of moving an entity to a different program, * including updating entity records and clearing relevant caches. - [Move Multiple Entities](https://api-docs.helpyousponsor.com/api-reference/programs/move-multiple-entities.md): Handles the process of moving multiple entities to a different program, * including updating entity records and clearing relevant caches. - [Remove a program](https://api-docs.helpyousponsor.com/api-reference/programs/remove-a-program.md) - [Remove a saved view](https://api-docs.helpyousponsor.com/api-reference/programs/remove-a-saved-view.md) - [View compatible programs when moving entities](https://api-docs.helpyousponsor.com/api-reference/programs/view-compatible-programs-when-moving-entities.md): Moves an entity to a different program, * retrieves necessary details for the move operation including compatible programs, * entity details, and more. - [Entity table headers](https://api-docs.helpyousponsor.com/api-reference/programs/entity-table-headers.md) - [Post Field Options](https://api-docs.helpyousponsor.com/api-reference/programs/post-field-options.md): Saves field options for a specific program, and optionally, a specific type. * This includes saving preferences in Redis and handling report saving. - [Select Saved View](https://api-docs.helpyousponsor.com/api-reference/programs/select-saved-view.md): Handles the selection of a saved report, * updating admin preferences in Redis and clearing relevant caches. - [Add a form field](https://api-docs.helpyousponsor.com/api-reference/program-forms/add-a-form-field.md): Add a new field to a form - [Create a new form](https://api-docs.helpyousponsor.com/api-reference/program-forms/create-a-new-form.md) - [Delete a form](https://api-docs.helpyousponsor.com/api-reference/program-forms/delete-a-form.md): Delete a form by its id - [Edit a form field](https://api-docs.helpyousponsor.com/api-reference/program-forms/edit-a-form-field.md): Edit an existing field in a form - [Form Details](https://api-docs.helpyousponsor.com/api-reference/program-forms/form-details.md): Form Details - [Form field types](https://api-docs.helpyousponsor.com/api-reference/program-forms/form-field-types.md) - [Get all forms](https://api-docs.helpyousponsor.com/api-reference/program-forms/get-all-forms.md): Returns a list of all forms for a specific client - [Manage a form](https://api-docs.helpyousponsor.com/api-reference/program-forms/manage-a-form.md) - [Update a form](https://api-docs.helpyousponsor.com/api-reference/program-forms/update-a-form.md): Update a form - [Delete a form field](https://api-docs.helpyousponsor.com/api-reference/program-forms/delete-a-form-field.md): Delete an existing field in a form - [List programs and forms](https://api-docs.helpyousponsor.com/api-reference/progress-reports/list-programs-and-forms.md) - [Post progress report](https://api-docs.helpyousponsor.com/api-reference/progress-reports/post-progress-report.md) - [Add a new admin](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/add-a-new-admin.md) - [Admin details](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/admin-details.md) - [Create a new group](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/create-a-new-group.md) - [Delete a group by ID](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/delete-a-group-by-id.md) - [Edit a specific group](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/edit-a-specific-group.md) - [Edit an existing admin](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/edit-an-existing-admin.md) - [Get a group by ID](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/get-a-group-by-id.md) - [List a donors and programs](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/list-a-donors-and-programs.md) - [List permission sets or admin groups](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/list-permission-sets-or-admin-groups.md) - [Manually activate an admin](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/manually-activate-an-admin.md) - [Manually deactivate an admin](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/manually-deactivate-an-admin.md) - [Remove an admin](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/remove-an-admin.md) - [View all admins](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/view-all-admins.md) - [View all groups](https://api-docs.helpyousponsor.com/api-reference/admins-&-permissions/view-all-groups.md) - [Create a new note](https://api-docs.helpyousponsor.com/api-reference/notes/create-a-new-note.md) - [Edit a note](https://api-docs.helpyousponsor.com/api-reference/notes/edit-a-note.md) - [Get note details](https://api-docs.helpyousponsor.com/api-reference/notes/get-note-details.md) - [View notes](https://api-docs.helpyousponsor.com/api-reference/notes/view-notes.md) - [Create a child program](https://api-docs.helpyousponsor.com/api-reference/program-options/create-a-child-program.md) - [Create a sub program](https://api-docs.helpyousponsor.com/api-reference/program-options/create-a-sub-program.md) - [Get campaign program details](https://api-docs.helpyousponsor.com/api-reference/program-options/get-campaign-program-details.md) - [Get details of a specific program](https://api-docs.helpyousponsor.com/api-reference/program-options/get-details-of-a-specific-program.md) - [Get program settings](https://api-docs.helpyousponsor.com/api-reference/program-options/get-program-settings.md) - [Manage programs](https://api-docs.helpyousponsor.com/api-reference/program-options/manage-programs.md) - [Add a donor form to a program](https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-donor-form-to-a-program.md) - [Add a sponsorship form to a program](https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-sponsorship-form-to-a-program.md) - [Add a submit form to a program](https://api-docs.helpyousponsor.com/api-reference/manage-program/add-a-submit-form-to-a-program.md) - [Attach an email set to a program](https://api-docs.helpyousponsor.com/api-reference/manage-program/attach-an-email-set-to-a-program.md) - [Attach settings to a program](https://api-docs.helpyousponsor.com/api-reference/manage-program/attach-settings-to-a-program.md) - [Add new setting](https://api-docs.helpyousponsor.com/api-reference/settings/add-new-setting.md) - [Delete a setting](https://api-docs.helpyousponsor.com/api-reference/settings/delete-a-setting.md) - [Edit a setting](https://api-docs.helpyousponsor.com/api-reference/settings/edit-a-setting.md) - [Get all settings](https://api-docs.helpyousponsor.com/api-reference/settings/get-all-settings.md) - [Get details for a setting](https://api-docs.helpyousponsor.com/api-reference/settings/get-details-for-a-setting.md) - [Get details for campaign settings](https://api-docs.helpyousponsor.com/api-reference/settings/get-details-for-campaign-settings.md) - [Post Template](https://api-docs.helpyousponsor.com/api-reference/templates/post-template.md): Handles saving or updating a template with provided CSS, * JavaScript, and HTML content based on the client ID. - [Retrieve Template](https://api-docs.helpyousponsor.com/api-reference/templates/retrieve-template.md): Fetches a specific template and associated pictures based on the client ID. - [Delete a file](https://api-docs.helpyousponsor.com/api-reference/files/delete-a-file.md) - [Edit a file](https://api-docs.helpyousponsor.com/api-reference/files/edit-a-file.md) - [Get file details](https://api-docs.helpyousponsor.com/api-reference/files/get-file-details.md) - [Get files table](https://api-docs.helpyousponsor.com/api-reference/files/get-files-table.md) - [Import CSV for a specific program](https://api-docs.helpyousponsor.com/api-reference/files/import-csv-for-a-specific-program-1.md) - [Import CSV for a specific program](https://api-docs.helpyousponsor.com/api-reference/files/import-csv-for-a-specific-program.md) - [Make placeholder picture](https://api-docs.helpyousponsor.com/api-reference/files/make-placeholder-picture.md) - [Make profile picture](https://api-docs.helpyousponsor.com/api-reference/files/make-profile-picture.md) - [Post a record upload](https://api-docs.helpyousponsor.com/api-reference/files/post-a-record-upload.md) - [Process the import job for donors and recipients](https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-donors-and-recipients.md) - [Process the import job for payments](https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-payments.md) - [Process the import job for sponsorship relationships](https://api-docs.helpyousponsor.com/api-reference/files/process-the-import-job-for-sponsorship-relationships.md) - [Rotate picture](https://api-docs.helpyousponsor.com/api-reference/files/rotate-picture.md) - [Upload a file](https://api-docs.helpyousponsor.com/api-reference/files/upload-a-file-1.md) - [Upload a file](https://api-docs.helpyousponsor.com/api-reference/files/upload-a-file.md) - [Add a designation to the checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/add-a-designation-to-the-checkout.md) - [Checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/checkout.md): Order to sponsor an entity - [Create a new donor and process their donation](https://api-docs.helpyousponsor.com/api-reference/frontend/create-a-new-donor-and-process-their-donation.md) - [Forgot Username](https://api-docs.helpyousponsor.com/api-reference/frontend/forgot-username.md): Handles the process for users who have forgotten their username by initiating a new session. - [Get Login Information](https://api-docs.helpyousponsor.com/api-reference/frontend/get-login-information.md): Retrieves login information and related details for a specific client and program. - [Handle the checkout process for sponsorships](https://api-docs.helpyousponsor.com/api-reference/frontend/handle-the-checkout-process-for-sponsorships.md) - [Login a donor and process their donation](https://api-docs.helpyousponsor.com/api-reference/frontend/login-a-donor-and-process-their-donation.md) - [Post Forgot Username](https://api-docs.helpyousponsor.com/api-reference/frontend/post-forgot-username.md): Handles the process for users who have forgotten their username * by verifying the email and sending the username to the user. - [Post Login](https://api-docs.helpyousponsor.com/api-reference/frontend/post-login.md): Handles the login process for a user, including validation and authentication. - [Post Logout](https://api-docs.helpyousponsor.com/api-reference/frontend/post-logout.md): Handles user logout by terminating the session and clearing related data. - [Post Reset Password](https://api-docs.helpyousponsor.com/api-reference/frontend/post-reset-password.md): Handles the password reset process including * verification and sending a temporary password to the user. - [Process a campaign checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/process-a-campaign-checkout.md) - [Remove a designation from the checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/remove-a-designation-from-the-checkout.md) - [Remove an entity from the checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/remove-an-entity-from-the-checkout.md) - [Reset Password](https://api-docs.helpyousponsor.com/api-reference/frontend/reset-password.md): Initiates a password reset process by generating a new session and returning session details. - [Update the amount for a specific entity in the checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-amount-for-a-specific-entity-in-the-checkout.md) - [Update the frequency for a specific designation in the checkout](https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-frequency-for-a-specific-designation-in-the-checkout.md) - [Update the frequency of a donation](https://api-docs.helpyousponsor.com/api-reference/frontend/update-the-frequency-of-a-donation.md) - [View a random entity](https://api-docs.helpyousponsor.com/api-reference/frontend/view-a-random-entity.md): Returns a random entity from a specific client and program - [Display titles and files with pagination](https://api-docs.helpyousponsor.com/api-reference/frontend/display-titles-and-files-with-pagination.md) - [Save an entity](https://api-docs.helpyousponsor.com/api-reference/frontend/save-an-entity.md): Saves an entity with the given details - [View entity details](https://api-docs.helpyousponsor.com/api-reference/frontend/view-entity-details.md) - [Delete a file](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/delete-a-file.md) - [Donor Credit Card Information](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-credit-card-information.md): Allows a donor to update their credit card information. - [Donor View Entity Message History](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view-entity-message-history.md): Returns message history for a specific donor entity. - [Donor View Entity](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view-entity.md): Displays a specific entity's profile and related information to the donor. - [Donor View](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/donor-view.md): Displays the donor's profile and related information, * handling the retrieval of donor data based on session ID. - [Get Donor Information](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/get-donor-information.md): Allows a donor to get their information. - [Get files for a donor](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/get-files-for-a-donor.md) - [Handle Donor File Uploads](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/handle-donor-file-uploads.md) - [Post Donor View Entity Message](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/post-donor-view-entity-message.md): Allows a donor to send a message to an entity. - [Save file upload to database](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/save-file-upload-to-database.md) - [Update Donor Information](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/update-donor-information.md): Allows a donor to update their information. - [Update Donor's Credit Card Information](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/update-donors-credit-card-information.md) - [Uploads a file for a donor](https://api-docs.helpyousponsor.com/api-reference/frontend-donor/uploads-a-file-for-a-donor.md) - [Add a new donor](https://api-docs.helpyousponsor.com/api-reference/donor-signup/add-a-new-donor.md) - [Sign up a new donor](https://api-docs.helpyousponsor.com/api-reference/donor-signup/sign-up-a-new-donor.md) - [Get organization's year in review](https://api-docs.helpyousponsor.com/api-reference/wrapped/get-organizations-year-in-review.md): Retrieves wrapped statistics for a given year. For large datasets (>10,000 donations) - [Check calculation status for wrapped statistics](https://api-docs.helpyousponsor.com/api-reference/wrapped/check-calculation-status-for-wrapped-statistics.md) ## OpenAPI Specs - [openapi](https://api-docs.helpyousponsor.com/api-reference/openapi.json) - [api-docs](https://api-docs.helpyousponsor.com/storage/api-docs/api-docs.json) ## Optional - [Documentation](https://docs.helpyousponsor.com/guides) - [Blog](https://mintlify.com/blog) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.