Create enterprise trial user

Create enterprise trial user

Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.

POSThttps://studio.edgeimpulse.com/v1/api-user-create-enterprise-trial

Body

application/json

Trial request

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

Example: "[e-mail]"

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.

Example: "My Company"

expirationDateTrialExpirationDate (string (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.

Example: "2020-01-01T00:00:00Z"

notesTrialNotes (string)

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

Example: "This is a trial for the company's new project."

useCasestring

Use case of the trial.

Example: "Industrial"

userHasMLModelsInProductionenum

Whether the user has ML models in production.

Example: "no"

yesnono, but we will soon

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

companySizestring

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

Example: "1-10"

countrystring

Country of the company requesting the trial.

Example: "United States"

stateOrProvincestring

State or province of the company requesting the trial.

Example: "California"

redirectUrlOriginstring

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

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

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

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

name*string

Name of the user.

Example: "John Doe"

username*string

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._-]+(?<![_.])$.

Example: "johndoe"

email*string

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

Example: "[e-mail]"

privacyPolicy*boolean

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.

Example: "TinyML engineer"

companyNamestring

Name of the company requesting the trial.

Example: "ACME Inc."

redirectUrlOriginstring

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

Example: "https://studio.edgeimpulse.com"

redirectUrlQueryParamsstring

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

Example: "utm_source=google&utm_medium=cpc&utm_campaign=trial"

utmParamsarray of UtmParameter (object)

List of UTM parameters.

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

idnullable integer

Unique identifier of the created entity, if any.

userIdinteger

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

redirectUrlstring

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

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api-user-create-enterprise-trial', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "John Doe",
      "username": "johndoe",
      "email": "[e-mail]",
      "privacyPolicy": false
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "redirectUrl": "text"
}