organization

Modify user organization membership.

Authentication required for this operation, authenticated user have admin role.

put/organization/{organizationId}/user/{email}

Request

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

Path parameters

organizationIdstring required
emailstring required

Request body

emailstring required

User's email.

firstNamestring

User's first name

lastNamestring

User's last name

organizationIdstring

Identifier for the organization.

purposestring

Optional purpose of invitation

rolestring

Role of the user within the organization. It determines the user's permissions.

Response

Organization membership has been modified.

alarmsChecksstring[]

The alarms checks ids of the organization.

billedPerLocationboolean

States if the organization is billed per location.

companyDetailsIdstring

The id of the company details.

countryCodestring

The 2 letter ISO code of the country of the organization

currencystring

Preferred currency for invoices etc

dashboardThemeIdstring

The dashboard theme id

descriptionstring

A description about the organization. Optional.

hideBillingboolean

States if we should hide the billing page.

hubspotIdstring

Unique identifier in Hubspot.

isActiveboolean

Whether it is active or deactivated.

isBillableboolean required

States if the organization is billable or not.

latitudenumber double

Organization’s geolocation latitude.

longitudenumber double

Organization’s geolocation longitude.

namestring

Displayable name of the organization.

prepaidboolean

States if the organization uses prepaid payments.

prepaidFromstring

States from which date the organization uses prepaid payments.

prepaidUntilstring

States until which date the organization uses prepaid payments.

serviceModelboolean

States if the organization has a service model or not.

tagsstring[]

The tags associated with the sensor check.

appsstring[]

The apps an organization has permissions for.

createdAtinteger

Timestamp of when the organization was created.

organizationIdstring

Unique identifier for the organization, preferably a readable text such as the domain name of the company.

activatedAtstring

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

activatedBystring

Identifier of the user that activated it.

deactivatedAtstring

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

deactivatedBystring

Identifier of the user that deactivated it.

billableboolean
noteMeasurementsByCategoryobject

Measurements defined for the notes of the organization, by note category and subcategory.

Changes

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