Newer Version Available

This content describes an older version of this product. View Latest

Creating Signups using the API


User Permissions Needed
To create or view signup requests: Signup Request API

You can use API calls to the SignupRequest object to create trial organizations for prospective customers. When creating trial organizations (or signups) using a web form, there’s no way to customize the signup process or track its status. Using the API, you can collect and analyze detailed information on all signups from your business organization. This gives you more control over the signup process, and enhanced visibility into your prospective customers. For example, you can:

  • Run reports and collect metrics, such as the number of signups per day or the number of signups in different countries.
  • Customize the SignupRequest object to add fields of special interest to your company.
  • Create triggers to initiate specific actions, such as sending an email notification, whenever a new signup request is made.
  • Enable signups from a wide range of client applications and devices, so you have additional channels for customer acquisition.
To start creating new signups using the API:
  1. Create a Trialforce Source Organization (TSO) from your Trialforce Management Organization.
  2. Install your app in the TSO, along with any sample data that might be useful for the trial.
  3. Configure the TSO as you want your customers to experience it, including specifying any custom branding.
  4. Create a Trialforce template from the TSO.
  5. File a case to activate this feature.
    1. Log in to the Partner Community.
    2. Under the Support tab, click New Case.
    3. Select the AppExchange and Feature Requests | Trialforce category.
    4. In the description, provide the following details.
      • the organization ID of your TSO
      • the template ID of the Trialforce template you want to use
      • the organization you plan to use for creating signups (so the appropriate user permission can be enabled)

    Although you can create new signups from any organization with the appropriate permissions, we recommend doing so from your business organization. You can then easily integrate signup data with your existing business processes. For example, you can create a workflow rule to convert each signup request into a lead or run reports to track the number of signups in a given period.

    Note

You’ll be notified by email once the template is approved. It can then be used to create new signups by making API calls to the SignupRequest object. See below for details of the SignupRequest object and a code sample demonstrating its use. For more information on working with objects, see the Object Reference for Salesforce and Lightning Platform