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. This API is internal (it requires some signed fields), sign up at https://studio.edgeimpulse.com/signup instead.

post

/api-user-create-enterprise-trial

Body

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

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.

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

notesstring

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

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

userHasMLModelsInProductionstring · enum

Whether the user has ML models in production.

Example: no

Options: yes, no, no, but we will soon

namestringrequired

Name of the user.

Example: John Doe

usernamestringrequired

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

emailstringrequired

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]

privacyPolicybooleanrequired

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

turnstileResponsestringrequired

CloudFlare Turnstile response token

utmParamsobject[]

List of UTM parameters.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api-user-create-enterprise-trial' \
  --header 'Content-Type: application/json' \
  --data '{"email":"[e-mail]","organizationName":"My Company","expirationDate":"2020-01-01T00:00:00Z","notes":"This is a trial for the company's new project.","useCase":"Industrial","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","userHasMLModelsInProduction":"no","name":"John Doe","username":"johndoe","privacyPolicy":true,"jobTitle":"TinyML engineer","turnstileResponse":"text","utmParams":[{"ANY_ADDITIONAL_PROPERTY":"anything"}]}'

200

200

{
  "success": true,
  "error": "text",
  "id": 1,
  "userId": 1,
  "redirectUrl": "text"
}

OK