app-installation

Patch a dynamic configuration, or creates it if does not exist.

Authentication required for this operation.

patch/app-installation/{installationId}/configuration/{configKey}

Request

  • Base URL: https://api.30mhz.com/api
  • URL: https://api.30mhz.com/api/app-installation/{installationId}/configuration/{configKey}
  • Auth: API key in header Authorization

Path parameters

installationIdstring required
configKeystring required

Request body

object required

Response

Returns installation the patched configuration belongs to.

descriptionstring

Installation's description.

dynamicConfigurationsobject
namestring

App installation name

activatedAtstring

The ISO601 UTC date the app was activated. e.g 2021-03-21T00:00:00Z

activatedBystring

The email of the user that activated this installation.

appIdstring

Application type.

deactivatedAtstring

The ISO601 UTC date the app was deactivated, e.g 2021-03-21T00:00:00Z. Ignored when the activatedAt is not set.

deactivatedBystring

The email of the user that deactivated this installation.

installationIdstring required

Application id.

installedAtstring

The ISO601 UTC date the app was installed. e.g 2021-03-21T00:00:00Z

installedBystring

The email of the user performing the installation.

locationIdstring

The site the installation belongs to. Use getSiteId() instead.

organizationIdstring

The unique identifier of the organization it belongs to.

siteIdstring required

The site the installation belongs to.

statusstring

The status of the installation.

isActiveboolean

Whether it is active or deactivated.

Changes

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