Create Professional Tier user

Create Professional Tier user

Create a new user for the Professional Plan and a new project. Note that the Professional plan will not be enabled until the payment is successful.

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

Body

application/json

name*string

Your name

Example: "Jan Jongboom"

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: "janjongboom"

email*string

E-mail address. Will need to be validated before the account will become active.

Example: "[e-mail]"

passwordstring

Password, minimum length 8 characters.

projectNamestring

A project will automatically be created. Sets the name of the first project. If not set, this will be derived from the username.

privacyPolicy*boolean

Whether the user accepted the privacy policy

activationTokenstring

Activation token for users created via SSO

identityProviderstring

Unique identifier of the identity provider asserting the identity of this user

jobTitlestring

Job title of the user. Optional field

sessionIdstring

Session ID. Optional field

companyNamestring

ACME Inc.

utmParamsarray of UtmParameter (object)

List of UTM parameters.

redirectUrlOriginstring

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

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

redirectUrlQueryParamsstring

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

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

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

redirectUrlstring

URL to redirect user to.

idinteger

User unique identifier

Request

JavaScriptCurl

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

Response

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