EDedgeimpulse
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

Request

Request body

namestring required

Your name

usernamestring required

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._-]+(?<![_.])$.

emailstring required

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

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.

privacyPolicyboolean required

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.

utmParamsUtmParameter[]

List of UTM parameters.

ignoreEmailValidationboolean

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

turnstileResponsestring required

CloudFlare Turnstile response token

dateOfBirthstring date

Date of birth of the user in YYYY-MM-DD format. Optional field.

approverEmailstring

Email address to be used for signup approval. Optional field.

redirectUrlOriginstring

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

redirectUrlQueryParamsstring

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

Example request

{
  "name": "Jan Jongboom",
  "username": "janjongboom",
  "email": "jan@edgeimpulse.com",
  "redirectUrlOrigin": "https://studio.edgeimpulse.com",
  "redirectUrlQueryParams": "utm_source=google&utm_medium=cpc&utm_campaign=trial"
}

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

redirectUrlstring required

URL to redirect user to.

idinteger required

User unique identifier

Changes

No recorded changes to this operation across all 1 revision of this API.