Skip to Content
Uptimeify Docs
Customers

Update Customer

Updates customer details.

PATCH /api/customers/:customerPublicId

Authentication

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

Request Body

All fields are optional. Omitted fields keep their current values.

{
  "name": "New Name",
  "email": "new@deinkunde.com",
  "status": "active",
  "packageType": "business", // configured packageType or displayName for the organization
  "notificationEmail": "alerts@customer-a.de",
  "notificationPhoneNumber": "+491701234567",
  "monthlyReportsEnabled": true,
  "companyName": "Nordwind ApS",
  "emailLanguage": "en",
  "customFields": {
    "internalReference": "KD-999"
  }
}

Notes:

  • packageType can contain the configured package key or the package display name of the organization. Known aliases such as aquisition_test are normalized automatically. A value that resolves to no package of this organization is rejected with 400 and data.code invalidPackageType; it is no longer stored as-is.
  • companyName is optional: the customer's company name, shown as "Company" on the customer page. Empty or null clears it.
  • emailLanguage sets the language of the e-mails this customer receives (alerts, reports, status pages): de, en or da. null returns it to the organization's language. Text messages to this customer use the same language. Any other value is rejected with 400.

Ownership & permission overrides (optional)

These fields control the customer's managed vs. self-service permissions and channel-type policy. They are organization-write gated: a customer-scoped caller's writes to these fields are silently ignored server-side.

null means inherit from the customer's package config.

FieldTypeDefaultDescription
allowSelfServiceboolean|nullnull (inherit)Whether the customer may create and manage self_service monitors
maxSelfServiceUrlsnumber|nullnull (inherit)Cap on the customer's total self_service monitors across all monitor types
canEditManagedbooleanfalseException: lets this customer edit managed monitors (class flips stay org-only). Changes are written to the audit log.
enableEmailAlertsboolean|nullnull (inherit)Whether your organization's own email channels alert about this customer (null = follow the package). Never affects channels the customer sets up themselves
enableSmsAlertsboolean|nullnull (inherit)Whether your organization's own SMS channels alert about this customer (null = follow the package). Never affects channels the customer sets up themselves
enableWebhookAlertsboolean|nullnull (inherit)Whether your organization's own webhooks channels alert about this customer (null = follow the package). Never affects channels the customer sets up themselves
enableIntegrationAlertsboolean|nullnull (inherit)Whether your organization's own integrations channels alert about this customer (null = follow the package). Never affects channels the customer sets up themselves
enablePostRequestEscalationboolean|nullnull (inherit)Channel-type policy override: POST-request escalation

The legacy notificationChannels JSONB override is deprecated: channel-type policy lives in the enable* fields above.

Example Request

curl -X PATCH "$BASE_URL/api/customers/6bfec6f6-245a-47ce-843b-157d97d56f88" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer A GmbH (Updated)",
    "monthlyReportsEnabled": true
  }'

Example Response

{
  "id": 101,
  "publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88",
  "organizationId": 1,
  "name": "Customer A GmbH (Updated)",
  "email": "contact@customer-a.de",
  "notificationPhoneNumber": "+491701234567",
  "notificationEmail": "alerts@customer-a.de",
  "packageId": 3,
  "packageType": "growth",
  "status": "active",
  "monthlyReportsEnabled": true,
  "companyName": "Nordwind ApS",
  "emailLanguage": "en",
  "customFields": {
    "internalReference": "KD-999"
  },
  "notificationChannels": null,
  "notificationTargets": null,
  "allowSelfService": null,
  "maxSelfServiceUrls": null,
  "canEditManaged": false,
  "enableEmailAlerts": null,
  "enableSmsAlerts": null,
  "enableWebhookAlerts": null,
  "enableIntegrationAlerts": null,
  "enablePostRequestEscalation": null,
  "updatedAt": "2026-02-26T19:37:00.000Z"
}

packageType and permission overrides: packageType is the raw package key of the customer (the value packageType in the request body resolves to). The permission overrides (allowSelfService, maxSelfServiceUrls, canEditManaged, enableEmailAlerts, enableSmsAlerts, enableWebhookAlerts, enableIntegrationAlerts, enablePostRequestEscalation; null = inherit from the package) are present only for callers that may also write them: an organization admin with an unrestricted customer scope. For a customer-bound token, any user without the admin role (editor, readonly), or a global supporter the fields are left out of the response.

Common Errors

  • 400 Invalid Customer identifier
  • 400 notificationPhoneNumber is not in international format (+ and country calling code) or not from the EU/EEA, Switzerland or the UK (data.code: smsCountryNotAllowed). Only a changed number is checked.
  • 400 Invalid packageId / packageType for this organization (data.code: invalidPackageType)
  • 401 Unauthorized
  • 403 Forbidden: your role is readonly, or you are a global supporter
  • 404 Customer not found (customerNotFound): the customer does not exist, belongs to another organization or lies outside your customer scope. Until 20.10.2026 the last case answered 403.
  • 500 Failed to update customer

On this page