HYS Documentation
Api ReferenceWebsiteGo to App
  • INTRODUCTION
    • About HelpYouSponsor
    • Key features overview
    • Concepts & Key Terms
  • GETTING STARTED
    • Navigation
    • Dashboard
    • Quick Start Guide
      • Account Information
      • Email Settings
      • Payment Gateways
        • Stripe Setup
          • Stripe Webhook
        • Flutterwave Setup
        • QPayPro Setup
        • Authorize.net Setup
        • PayPal Setup
    • Account Setup
      • First Program Setup
      • Website Integration
      • Campaign Setup
  • CORE FEATURES
    • Program Management
      • Manage Programs
      • Program Forms
      • Program Settings
      • Auto Emails
      • Additional Gifts
      • Url Generator
    • Donor Management
      • Donors Table
      • Add Donor
      • Donor Profile Page
    • Recipient Management
      • Recipients Table
      • Add Recipient
    • Sponsorship Management
      • Sponsorships Table
      • Add Sponsorship
    • Donation Management
      • Donations Table
    • Communication Tools
      • Message Manager
      • Newsletter
  • ADVANCED FEATURES
    • Customization Options
    • Reporting and Analytics
    • Progress Reports
      • Create Progress Report
      • Add Progress Report Data
    • Integrations
      • Mailgun
      • Box Image Storage
      • Zapier
        • Actions
          • Create a New Donor
          • Edit Donor
          • Find Donor By Email Address
          • Find Donor Forms
          • Create a New Entity
          • Edit Entity
          • Find Entity by ID
          • Find Programs
        • Triggers
          • New Form
          • New Program
          • New Donor
          • New Entity
          • New Donations
      • QuickBooks
        • Connect to HelpYouSponsor
        • Adding Donors (Customers)
        • Recipients (Service item)
        • Donations (Sales Receipt)
        • Mapping fields from HYS to QuickBooks fields
        • Synchronized Currency
  • ADMINISTRATION
    • User Management
    • Permissions and Access Control
    • Security Settings
  • BEST PRACTICES
    • Donor Engagement Strategies
    • Fundraising Tips
    • Data Management
  • TROUBLESHOOTING
    • Common Issues and Solutions
    • FAQs
      • How do I import data into my account?
      • How do I bulk upload files?
      • How do I export all the data in my account?
    • Support Resources
      • Priority Support & Enhancements Options
      • How to close my account?
  • API DOCUMENTATION
    • Authentication
    • Endpoints
    • Code Examples
  • RELEASE NOTES
    • Version History
    • Upcoming Features
Powered by GitBook
On this page
  • Creating a Program Form.
  • Program Form Cards
  1. CORE FEATURES
  2. Program Management

Program Forms

PreviousManage ProgramsNextProgram Settings

Last updated 1 month ago

Program Forms allow you to create and manage different types of forms used throughout your sponsorship programs. These forms collect information from both donors and recipients.

HelpYouSponsor offers two types of forms;

  • Recipient Profile form: Used to collect recipient information.

  • Donor Profile form: Used to collect donor information.

  • Progress Report form: Used to create fields to display in reports.

To navigate to "Program Forms" click on "Campaigns & Programs" on the main menu and click on the "Program Forms" tab.

Creating a Program Form.

To create a program form, click on the "Create Form" button on the top right. This will open up a drawer with two fields;

  • Program Form name (required)

  • Program Form type (required): Select from any of the listed program types.

Program Form Cards

The program form cards show the program forms you have in the system and their types. These cards give you quick access to actions like;

  • Editing the program form.

  • Managing program form fields.

  • Bulk editing program form fields.

  • Deleting the program form.

Editing the program form

To edit the program form, click the "Edit Form" button on the card. This will open up a drawer with the form. Here you are able to change the Program Form Name only.

Managing program form fields

Managing program form fields give you the ability to add new fields, rearrange the order in which programs are listed, edit the fields names, and also delete fields.

To manage program form fields click on the "Manage fields" button. This will open up a drawer with two tabs.

Manage Form Fields

This tab shows you all the fields you currently have in your form. Each row shows the following;

  • The field name or label,

  • The edit button to edit the field.

  • The delete button to delete the field.

NOTE: The order of the fields in the form can rearranged by dragging the field up or down the list using the six vertical dots on the left side of the field name.

Add New Field

Let us look through the different inputs required to create a new form field.

  1. Field Label.

    This is the name on the field you want to add. eg Child Name.

  2. Field Type.

    This is the type of information you would want to collect from donors or recipients. HelpYouSponsor provides the following field types.

    • Text.

    • Textarea.

    • Static Text.

    • Age.

    • Date.

    • Link.

    • Select List.

    • Checkbox.

    • Table.

    • Auto Increment ID.

    More information about the field type is provided in the green box below the field type in the form.

  3. Permissions.

    This gives visibility of the field to the selected group of people. The permissions include;

    • Everyone.

    • Donors and Admins.

    • Admins Only.

  4. Title.

    This will make the field to be used as the profile title or name.

  5. Required.

    This makes sure that the field is filled when collecting information.

  6. Sortable.

    This makes the field sortable when viewing the collected data.

  7. Filter.

    This makes the field filterable when viewing the collected data.

  8. Unique.

    This makes sure that the data collected in this field is not duplicated.

Bulk editing program form fields

To bulk edit program form fields, click on the three horizontal dots on the top right corner of the Program form card and select "Bulk Editor" in the dropdown.

This will open up a dialog with a JSON editor.

Each field in the program form is an object with its fields and values. Here you can bulk edit the form by removing objects to delete fields, adding objects to add fields and editing existing objects to edit the fields.

Below is the placeholder of the values each key in the object is expected to have.

[
  {
    "field_label": "Name",
    "field_data": "",
    "type": "household",
    "field_type": "hysText/hysTextarea/hysStatic/hysAge/hysDate/hysLink/hysSelect/hysCheckbox/hysTable/hysCustomid",
    "permissions": "public/donor/admin",
    "filter": true,
    "is_title": true,
    "is_unique": true,
    "required": true,
    "sortable": true
  }
]

NOTE: This should be done by a person with good knowledge about JSON.

Deleting a program form

To delete a program form, click on the three horizontal dots on the top right corner of the Program form card and select "Delete Form" in the dropdown.

The field short code [this is used in ].

auto emails
Creating a Program Form form.
Editing a program form
Manage Form Fields
Add New Field