organization

Deactivates a site.

Only system administrators can deactivate site.

post/organization/{organizationId}/site/{siteId}/deactivate

Request

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

Path parameters

organizationIdstring required
siteIdstring required

Request body

object required

Response

Site deactivated

billableSincestring

Date since the site is billable in UTC, e.g. 2020-12-24T18:51:31Z

contractLengthinteger

Number of months from the start date through which the contract is effective.

latitudenumber double

Angular distance north or south of the equator.

longitudenumber double

Angular distance east or west of the prime meridian.

namestring required

Set of words by which a site is known.

subscriptionIdstring required

Unique identifier for the subscription.

timezonestring

An area which observes a uniform standard time.

aerialImageDataUploadIdstring

Id of the aerial image data upload.

aerialImagePresignedUrlstring

Presigned URL of the aerial image.

deactivatedAtstring

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

idstring required

Identifier of the site it belongs to, together with the organizationId this is unique.

organizationIdstring

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

status'ACTIVE' | 'DELETED' | 'INACTIVE' | 'PENDING'

Current status of the site.

urlPathIdentifierstring

URL friendly identifier of the site based on the name of the site.

uuidstring

Universally unique identifier.

isActiveboolean

Whether it is active or deactivated.

Changes

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