POST
/
api
/
user
/
trial
Start enterprise trial
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/user/trial \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "email": "fred@flintstones.org",
  "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"
}'
{
  "success": true,
  "error": "<string>",
  "id": 123,
  "userId": 123,
  "redirectUrl": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
email
string

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:

"fred@flintstones.org"

​
name
string

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"

​
organizationName
string

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"

​
expirationDate
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"

​
notes
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."

​
useCase
string

Use case of the trial.

Example:

"Industrial"

​
userHasMLModelsInProduction
enum<string>

Whether the user has ML models in production.

Available options:
yes,
no,
no, but we will soon
Example:

"no"

​
companyName
string

Name of the company requesting the trial.

Example:

"ACME Inc."

​
companySize
string

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

Example:

"1-10"

​
country
string

Country of the company requesting the trial.

Example:

"United States"

​
stateOrProvince
string

State or province of the company requesting the trial.

Example:

"California"

​
redirectUrlOrigin
string

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

Example:

"https://studio.edgeimpulse.com"

​
redirectUrlQueryParams
string

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"

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

Unique identifier of the created entity.

​
userId
integer

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

​
redirectUrl
string

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

​
error
string

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