EDedgeimpulse
User

Create enterprise trial user

Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization. This API is internal (it requires some signed fields), sign up at https://studio.edgeimpulse.com/signup instead.

post/api-user-create-enterprise-trial

Request

Request body

emailstring required

Email of the user. Only business email addresses are allowed. Emails with free domains like gmail.com or yahoo.com are not allowed.

namestring required

Name of the user.

organizationNamestring

Name of the trial organization. All enterprise features are tied to an organization. This organization will be deleted after the trial ends. If no organization name is provided, the user's name will be used.

expirationDatestring date-time

Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.

notesstring

Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.

useCasestring

Use case of the trial.

userHasMLModelsInProduction'yes' | 'no' | 'no, but we will soon'

Whether the user has ML models in production.

companyNamestring

Name of the company requesting the trial.

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

countrystring

Country of the company requesting the trial.

stateOrProvincestring

State or province of the company requesting the trial.

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

usernamestring required

Username, minimum 4 and maximum 30 characters. May contain alphanumeric characters, hyphens, underscores and dots. Validated according to ^(?=.{4,30}$)(?![_.])(?!.*[_.]{2})[a-zA-Z0-9._-]+(?<![_.])$.

privacyPolicyboolean required

Whether the user has accepted the terms of service and privacy policy.

passwordstring

Password of the user. Minimum length 8 characters.

jobTitlestring

Job title of the user.

utmParamsUtmParameter[]

List of UTM parameters.

turnstileResponsestring required

CloudFlare Turnstile response token

Example request

{
  "email": "jan@edgeimpulse.com",
  "name": "John Doe",
  "organizationName": "My Company",
  "expirationDate": "2020-01-01T00:00:00Z",
  "notes": "This is a trial for the company's new project.",
  "useCase": "Industrial",
  "userHasMLModelsInProduction": "no",
  "companyName": "ACME Inc.",
  "companySize": "1-10",
  "country": "United States",
  "stateOrProvince": "California",
  "redirectUrlOrigin": "https://studio.edgeimpulse.com",
  "redirectUrlQueryParams": "utm_source=google&utm_medium=cpc&utm_campaign=trial",
  "username": "johndoe",
  "jobTitle": "TinyML engineer"
}

Response

OK

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

idinteger required

Unique identifier of the created entity.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring required

URL to redirect the user to in order to access the enterprise trial.

Changes

No recorded changes to this operation across all 1 revision of this API.