Organizations

PATCH /api/organizations/{id}

patch/api/organizations/{id}

Request

  • Base URL: https://uptimeify.io
  • URL: https://uptimeify.io/api/organizations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
companyNamestring
streetstring
postalCodestring
citystring
countrystring
vatIdstring
countryCodestring
billingEmailstring email
smsOverageSafetyCapCentsMonthlyinteger nullable
quotaWebsitesLimitinteger nullable
quotaIpsLimitinteger nullable
quotaSmsIncludedinteger nullable
quotaMonthlyPriceCentsinteger nullable
quotaExtraSmsPriceCentsinteger nullable
quotaAutoUpgradeEnabledboolean
quotaChangeEffective'immediately' | 'period_end'
requireMfaAdminsboolean
requireMfaEditorsboolean
requireMfaReadonlyboolean
requireMfaCustomersboolean
defaultNotificationRulesobject

Response

Successful response

idinteger required
publicIdstring uuid required
namestring required
statusstring required

active or suspended.

deletionDueAtstring date-time nullable required

Set while a deletion request runs out its notice period.

emailLanguagestring nullable required
billingEmailstring nullable required

null for roles other than admin.

billingCyclestring nullable required

monthly; null for roles other than admin.

paymentMethodstring nullable required

invoice or mollie; null for roles other than admin.

defaultNotificationRulesobject nullable required
requireMfaAdminsboolean
requireMfaEditorsboolean
requireMfaReadonlyboolean
requireMfaCustomersboolean
companyNamestring nullable
streetstring nullable
postalCodestring nullable
citystring nullable
countrystring nullable
vatIdstring nullable
discountCodeIdinteger nullable
discountAppliedAtstring date-time nullable
trialForfeitedboolean

The free trial was used and forfeited; GET only.

quotaWebsitesLimitinteger nullable
quotaIpsLimitinteger nullable
quotaSmsIncludedinteger nullable
quotaMonthlyPriceCentsinteger nullable
quotaExtraSmsPriceCentsinteger nullable
quotaEffectiveAtstring date-time nullable
quotaAutoUpgradeEnabledboolean
smsOverageSafetyCapCentsMonthlyinteger nullable
smsOverageCapLastAlertedPeriodstring nullable
smsOverageCapLastAlertedAtstring date-time nullable
smsOverageCapBlockedAtstring date-time nullable
smsOverageCapBlockedReasonstring nullable

Changes

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