Update Customer

PATCH /api/customers/:customerPublicId

Updates customer details.

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@example.com",
  "status": "active",
  "packageType": "business", // configured packageType or displayName for the organization
  "notificationEmail": "alerts@customer-a.de",
  "notificationPhoneNumber": "+491701234567",
  "monthlyReportsEnabled": true,
  "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.

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,
  "status": "active",
  "monthlyReportsEnabled": true,
  "customFields": {
    "internalReference": "KD-999"
  },
  "notificationChannels": null,
  "notificationTargets": null,
  "updatedAt": "2026-02-26T19:37:00.000Z"
}

Common Errors

400 Invalid Customer identifier
401 Unauthorized
403 Forbidden / Organization ID not found
404 Customer not found
500 Failed to update customer