Start enterprise trial

Start enterprise trial

post

Create an enterprise trial for the current user. Users can only go through a trial once.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Body

emailstringOptional

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: [email protected]

namestringOptional

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

Example: Fred Flintstone

organizationNamestringOptional

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-timeOptional

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

notesstringOptional

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.

useCasestringOptional

Use case of the trial.

Example: Industrial

userHasMLModelsInProductionstring · enumOptional

Whether the user has ML models in production.

Example: noPossible values:

companyNamestringOptional

Name of the company requesting the trial.

Example: ACME Inc.

companySizestringOptional

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

Example: 1-10

countrystringOptional

Country of the company requesting the trial.

Example: United States

stateOrProvincestringOptional

State or province of the company requesting the trial.

Example: California

redirectUrlOriginstringOptional

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

Example: https://studio.edgeimpulse.com

redirectUrlQueryParamsstringOptional

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

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/user/trial HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 480

{
  "email": "[email protected]",
  "name": "Fred Flintstone",
  "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"
}

200

OK

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