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

post

/api-create-pro-user

Body

namestringrequired

Your name

Example: Jan Jongboom

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

emailstringrequired

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.

privacyPolicybooleanrequired

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.

ignoreEmailValidationboolean

If true, allows signup to proceed despite a potentially invalid email. Note that this will enforce email verification post-signup

turnstileResponsestringrequired

CloudFlare Turnstile response token

utmParamsobject[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api-create-pro-user' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Jan Jongboom","username":"janjongboom","email":"[e-mail]","privacyPolicy":true,"turnstileResponse":"text","utmParams":[{"ANY_ADDITIONAL_PROPERTY":"anything"}],"redirectUrlOrigin":"https://studio.edgeimpulse.com","redirectUrlQueryParams":"utm_source=google&utm_medium=cpc&utm_campaign=trial"}'

200

200

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

OK