Uptimeify Docs

Appearance

Customer Management ​

Endpoints ​

List Customers ​

GET /api/customers

Lists all customers of the organization.

Query Parameters ​

  • organizationId (required): The ID of the organization.

Create Customer ​

POST /api/customers

Creates a new customer and assigns a package.

Request Body ​

json
{
  "name": "Customer Name",
  "email": "customer@example.com",
  "packageType": "essential", // essential, selfservice, fullservice
  "organizationId": 1,
  "status": "active", // optional, default: active
  "customFields": { ... } // optional
}

Get Customer Details ​

GET /api/customers/:id

Returns details of a specific customer.

Update Customer ​

PUT /api/customers/:id

Updates customer details.

Request Body ​

json
{
  "name": "New Name",
  "email": "new@example.com",
  "status": "active"
}

Change Package ​

PATCH /api/customers/:id/package

Changes the customer's package.

Request Body ​

json
{
  "packageType": "fullservice"
}

Cancel Customer ​

POST /api/customers/:id/cancel

Marks a customer for cancellation.

Revoke Cancellation ​

DELETE /api/customers/:id/cancel

Removes the cancellation mark.