SignupRequest

Represents a request for a new sign-up.

You’re limited to 20 sign-ups per day. To make additional sign-ups, log a support case in the Salesforce Partner Community. For product, specify Sales. For topic, specify AppExchange & Managed Packages.

Introduced in API version 27.0.

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

• Type: textarea
• Properties: Create, Nillable
• Introduced: API version 39.0

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 29.0
• 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 after the sign-up request has been processed.

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
• Introduced: API version 54.0

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 38.0

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 57.0

• Type: string
• Properties: Create, Filter, Group, Sort
• Description: The name of the company requesting the trial sign-up.

• Type: textarea
• Properties: Create, Nillable
• Introduced: API version 28.0
• Description: When used with ConnectedAppConsumerKey, specifies a connected app that’s approved automatically during the sign-up creation.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 28.0
• Description: When used with ConnectedAppCallbackUrl, specifies a connected app that’s approved automatically during the sign-up creation.

• Type: string
• Properties: Create, Filter, Group, Sort
• Description: The default value is the country of the requesting org. To override the default, enter the two-character, uppercase ISO-3166 country code (Alpha-2 code). A complete list of the codes is located at https://www.iso.org/obp/ui/#search. The language of the trial org is auto-determined based on the value of this field.

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Description: The 15-character org ID of the trial org created. The system provides this read-only field after the sign-up request has been processed.

• Type: string
• Properties: Group, Nillable
• Introduced: API version 29.0
• Description: The server instance of the new trial org, for example, “na8.” This field is available in API version 29.0 and later.

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
• Introduced: API version 35.0
• Description: The Salesforce template that is used to create the trial org. Possible values are Partner Group, Professional, Partner Professional, Sales Enterprise, Professional TSO, Enterprise, Partner Enterprise, Service Professional, Enterprise TSO, Developer, and Partner Developer.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 37.0

• 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.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Description: The first name of the admin user for the trial sign-up.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 41.0

• Type: boolean

• Properties: Create, Defaulted on create, Filter, Group, Sort

• Introduced: API version 29.0

• Default value: false

• Type: boolean

• Properties: Create, Defaulted on create, Filter, Group, Sort

• Introduced: API version 33.0

• Default value: false

• Type: boolean

• Properties: Create, Defaulted on create, Filter, Group, Sort

• Introduced: API version 36.0

• Default value: false

• Type: string
• Properties: Create, Filter, Group, Sort
• Description: The last name of the admin user for the trial sign-up.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 37.0

• Type: textarea
• Properties: Nillable
• Introduced: API version 33.0

• Type: string
• Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
• Description: The name of the Signup Request.

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
• Introduced: API version 35.0
• Description: The language of the trial org being created. Specify the language using a language code listed under Fully Supported Languages in Supported Languages in 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 org 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 org defaults to the default language of the country.

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 35.0
• Description: Populated during the sign-up request and for internal use by Salesforce.

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort
• Introduced: API version 35.0
• Description: When set to true, the trial org is connected to the Environment Hub. The sign-up must take place in the hub main org or a spoke org.
• Default value: false

• Type: email
• Properties: Create, Filter, Group, Sort
• Description: The email address of the admin user for the trial sign-up.

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort
• Introduced: API version 36.0
• Description: A user-specified description of the trial sign-up, up to 60 characters.

• Type: picklist
• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
• Description: The status of the request. Possible values are New, In Progress, Error, or Success. The default is New.

• Type: string

• Properties: Create, Filter, Group, Nillable, Sort

• Introduced: API version 29.0

• Description:

  The My Domain name for the new trial org used in the org’s login and application URLs. In Developer Edition orgs, your name must contain at least 3 characters and no more than 27 characters. In all other editions, it must be at least 3 characters and no more than 34 characters. It can include letters, numbers, and hyphens, but you can’t start the name with a hyphen.

  If you don’t choose a My Domain during sign-up, Salesforce assigns one for you based on your company name. If you don’t like the one we set, you can change it.

  For details, see My Domain in Salesforce Help.

• Type: string
• Properties: Filter, Group, Nillable, Sort

• 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.

• Type: int
• Properties: Create, Filter, Group, Nillable, 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.

• Type: string
• Properties: Filter, Group, Nillable, Sort
• Description: The 15-character org ID of the Trialforce Source Organization (TSO) from which the Trialforce template was created.

• 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.

The Java class uses REST API to create a SignupRequest object. It authenticates to the Trialforce Management Organization (TMO) 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 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, in the Quick Find box, enter Apps, and then select Apps. Under Connected Apps, click New. Enter values for the required fields (Callback URL is required, but you can initially set it to any valid URL because 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.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.

• SignupRequestHistory

• SignupRequestFeed

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 sign-up.
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-1034	Can’t create the org. Contact Salesforce Customer Support for assistance.
C-9999	Generic fatal error. Contact Salesforce Customer Support for assistance.
S-1006	Invalid email address (not in a proper email address format).
S-1014	Invalid or missing parameters during the sign-up process. Possible solutions include: Indicate a valid callback URL. If indicated, be sure to provide both a Consumer Key and callback URL.
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. A namespace must begin with a letter, can’t contain consecutive underscores, can’t be a restricted or reserved namespace, and must be 15 characters or fewer.
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. Contact Salesforce Customer Support for assistance.
T-0004	The Trialforce Source Organization (TSO) for the template doesn’t exist or has expired.
VR-0001	Can’t create the scratch org. Try again later.
VR-0002	Can’t create the scratch org. Check that the release value is valid. If no release value was specified, contact Salesforce Customer Support.
VR-0003	Can’t create the scratch org. Check that the release value is valid. If no release value was specified, contact Salesforce Customer Support.

This object has the following associated objects. Unless noted, they’re available in the same API version as this object.

• SignupRequestFeed–Feed tracking is available for the object.
• SignupRequestHistory–History is available for tracked fields of the object.
• SignupRequestOwnerSharingRule–Sharing rules are available for the object
• SignupRequestShare–Sharing is available for the object.