SignupRequest

Represents a request for a new signup. This object is available in API version 27.0 and later.

You are limited to 20 signups per day. To make additional signups, log a case in the Partner Community.

Note

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()

Fields

Field Name	Details
AuthCode	Type string Properties Create, Filter, Group, Sort Description A one-time authorization code that can be exchanged for an OAuth access token and refresh token using standard Salesforce APIs. It’s used with ConnectedAppCallbackUrl and ConnectedAppConsumerKey, when the specified connected app hasn't been configured with an X.509 certificate. The system provides this read-only field once the sign-up request has been processed. This field is available in API version 29.0 and later.
Company	Type string Properties Create, Filter, Group, Sort Description The name of the company requesting the trial sign-up.
ConnectedAppCallbackUrl	Type string Properties Create, Filter, Group, Sort Description When used with ConnectedAppConsumerKey, specifies a connected app that’s approved automatically during the sign-up creation. This field is available in API version 28.0 and later.
ConnectedAppConsumerKey	Type string Properties Create, Filter, Group, Sort Description When used with ConnectedAppCallbackUrl, specifies a connected app that’s approved automatically during the sign-up creation. This field is available in API version 28.0 and later.
Country	Type string Properties Create, Filter, Group, Sort Description The default value is the country of the requesting org. If you want to override the default, enter the two-character, upper-case ISO-3166 country code (Alpha-2 code). You can find a full list of these codes at several sites, such as: https://www.iso.org/obp/ui/#search. The language of the trial organization is auto-determined based on the value of this field.
CreatedOrgId	Type string Properties Filter, Group, Nillable, Sort Description The 15–character organization ID of the trial organization created. The system provides this read-only field once the sign-up request has been processed.
CreatedOrgInstance	Type string Properties Filter, Group, Nillable, Sort Description The server instance of the new trial organization, for example, “na8.” This field is available in API version 29.0 and later.
Edition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The Salesforce template that is used to create the trial organization. Possible values are Partner Group, Professional, Partner Professional, Sales Enterprise, Professional TSO, Enterprise, Partner Enterprise, Service Professional, Enterprise TSO, Developer, and Partner Developer. This field is available in API version 35.0 and later.
ErrorCode	Type string Properties Filter, Group, Nillable, Sort Description The error code if the sign-up request isn’t successful. The system provides this read-only field for support purposes.
FirstName	Type string Properties Create, Filter, Nillable, Sort Description The first name of the admin user for the trial sign-up.
LastName	Type string Properties Create, Filter, Group, Sort Description The last name of the admin user for the trial sign-up.
PreferredLanguage	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the trial organization being created. Specify the language using a language code listed under Fully Supported Languages in Supported Languagesin Salesforce Help. For example, use `zh_CN` for simplified Chinese. The value you select overrides the language set by the locale. If you specify an invalid language, the organization defaults to the default language of the country. Likewise, if you specify a language that isn’t supported by the Salesforce edition associated with your trial template, the trial organization defaults to the default language of the country. This field is available in API version 35.0 and later.
ResolvedTemplateId	Type string Properties Filter, Group, Nillable, Sort Description Populated during the sign-up request and for internal use by Salesforce. This field is available in API version 35.0 and later.
ShouldConnectToEnvHub	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description When set to true, the trial organization is connected to the Environment Hub. The sign-up must take place in the hub master organization or a spoke organization. This field is available in API version 35.0 and later.
SignupEmail	Type email Properties Create, Filter, Group, Sort Description The email address of the admin user for the trial sign-up.
SignupSource	Type string Properties Create, Filter, Group, Nillable, Sort Description A user-specified description of the trial sign-up, up to 60 characters in length. This field is available in API version 36.0 and later.
Status	Type picklist Properties Defaulted on create, Filter, Group, Sort, Update Description The status of the request. Possible values are New, In Progress, Error, or Success. The default value is New.
Subdomain	Type string Properties Create, Filter, Group, Sort Description The subdomain for the new trial organization when it uses a custom My Domain. The maximum length is 33 characters for Developer Edition (DE) and 40 characters for all other editions (because a suffix is appended to all DE organizations).
SuppressSignupEmails	Type boolean Properties Filter, Group, Nillable, Sort Description When set to true, no sign-up emails are sent when the trial organization is created. This field is used for the Proxy Signup feature, and is available in API version 29.0 and later.
TemplateId	Type string Properties Create, Filter, Group, Nillable, Sort Description The 15–character ID of the Trialforce template that is the basis for the trial sign-up. Salesforce must approve the template. If you don’t specify an edition, a template ID is required.
TrialDays	Type anyType Properties Create, Defaulted on create, Filter, Group, Sort Description The duration of the trial sign-up in days. Must be equal to or less than the trial days for the approved Trialforce template. If not provided, it defaults to the trial duration specified for the Trialforce template.
TrialSourceOrgId	Type string Properties Filter, Group, Nillable, Sort Description The 15–character organization ID of the Trialforce Source Organization from which the Trialforce template was created.
Username	Type string Properties Create, Filter, Group, Sort Description The username of the admin user for the trial sign-up. It must follow the address convention specified in RFC822: www.w3.org/Protocols/rfc822/#z10

Usage

The Java class uses the REST API to create a SignupRequest object. It authenticates to the Trialforce Management Organization and then posts a request to the SignupRequest object.

Here are the variables to specify in this example.

SERVER — The name of the host server for the Trialforce Management Organization (TMO), for example, “yourInstance.salesforce.com.”
USERNAME — The admin username for the TMO.
PASSWORD — The concatenation of the admin password and the security token for the TMO. To get an email with the security token, from your personal settings in Salesforce select Reset My Security Token and click Reset Security Token.
CLIENT_ID — From Setup in Salesforce, enter Apps in the Quick Find box, select Apps, and click New under Connected Apps. Enter values for the required fields (the Callback URL is required but can initially be set to any valid URL as it's not used), grant full access for the OAuth scopes in the "Selected OAuth Scopes" selector, and click Save. Then copy the value of “Consumer Key” and use it for this variable.
CLIENT_SECRET — On the same page, click Click to reveal. Then copy the value of "Consumer Secret" and use it for this variable.

Error Codes

If the sign-up fails, the system generates an error code that can help you identify the cause. This table shows the most important error codes.

Error Code	Description
C-1007	Duplicate username.
C-1015	Error while establishing the new org’s My Domain (subdomain) settings. Contact Salesforce support for assistance.
C-1016	Error while configuring the OAuth connected app for Proxy Signup. Verify that your connected app has a valid consumer key, callback URL, and unexpired certificate (if applicable).
C-1018	Invalid subdomain value provided during signup.
C-1019	Subdomain in use. Choose a new subdomain value.
C-1020	Template not found. Either the template doesn't exist (or it was deleted).
C-1033	Template is the wrong version.
C-9999	Generic “fatal error.” Contact Salesforce support for assistance.
S-1006	Invalid email address (not in a proper email address format).
S-1014	Invalid or missing parameters during signup process. Possible solutions include: Be sure to indicate a valid Callback URL. If indicated, be sure to provide both a ConsumerKey and Callback URL. For scratch orgs, be sure that you indicate only supported features in scratch org definition file.
S-1017	Namespace isn’t registered with a release org associated with the Dev Hub.
S-1018	Invalid My Domain (subdomain) name. Select a name that doesn’t: Contain double hyphens End in a hyphen Include restricted words Exceed 40 characters (33 for Developer Edition)
S-1019	My Domain (subdomain) already in use.
S-1026	Invalid namespace. Namespaces must begin with a letter, must not contain consecutive underscores, cannot be a restricted or reserved namespace, and must be 15 characters or fewer.
S-2006	Invalid country.
T-0001	Template ID not valid (not in the format 0TTxxxxxxxxxxxx).
T-0002	Template not found. Either the template doesn't exist (or it was deleted).
T-0003	Template not approved for use by Salesforce.

Object Reference for Salesforce and Lightning Platform

SignupRequest

Supported Calls

Fields

Usage

Error Codes