user

Invites valid users to join Zensie

This operation is Admins and account managers only, and this operation depends on the client captcha configuration. <br>the {organizationId} will be validated ,<br> The account should be activated; an email with the account confirmation email will be sent, this is required in order to activate the account.<br>Default oauth authentication mechanism required for this operation, and a valid captcha client.

post/user/invite/organization/{organizationId}/role/{role}

Request

  • Base URL: https://api.30mhz.com/api
  • URL: https://api.30mhz.com/api/user/invite/organization/{organizationId}/role/{role}
  • Auth: API key in header Authorization

Path parameters

organizationIdstring required
rolestring required

Query parameters

licenseIdstring

Request body

activityNotificationsobject

Activity notifications (type and frequency).

firstNamestring required

First name.

languagestring

IETF language tag, e.g. en-US

lastNamestring required

Last name.

metricSettingsobject[]

The user's preferred unit per metric, e.g. temperature: Fahrenheit

phoneNumberstring

Phone number.

rateLimitTier'tier1' | 'tier2' | 'tier3' | 'tier4'
statusstring

Indicates when a user is active or inactive.

timezonestring

The timezone of the user, defaults to Europe/Amsterdam

emailstring required

Email address.

Response

successful operation

activityNotificationsobject

Activity notifications (type and frequency).

firstNamestring

First name.

languagestring

IETF language tag, e.g. en-US

lastNamestring

Last name.

metricSettingsobject[]

The user's preferred unit per metric, e.g. temperature: Fahrenheit

phoneNumberstring

Phone number.

statusstring

Indicates when a user is active or inactive.

timezonestring

The timezone of the user, defaults to Europe/Amsterdam

activatedAtstring

UTC ISO 8601 timestamp of activation, e.g. e.g 2023-12-12T15:00:00Z.

emailstring required

Email address.

invitedBystring

Email address of user that sent the invite.

systemRolestring

System-wide role like: 'admin'

userIdstring

Universally unique identifier of a user.

Changes

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