user

Invites a user to an organization

post/user/invite

Request

  • Base URL: https://api.30mhz.com/api
  • URL: https://api.30mhz.com/api/user/invite
  • Auth: API key in header Authorization

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.

licenseIdstring

Optional license identifier driving the email template and sender

organizationIdstring required

Identifier of the organization the user is being invited to

rolestring required

Role to assign the invited user within the organization

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.