---
title: "Create Customer"
method: POST
path: "/api/customers"
tags: ["Customers"]
---

# Create Customer

`POST /api/customers`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/customers`
- Auth: HTTP bearer

POST /api/customers

## Request body

- object
  - `name` string, required: Required, not blank.
  - `email` string
  - `status` 'active' | 'inactive': Default active.
  - `packageType` string: Package type; this or packageId is required.
  - `packageId` union: Package configuration id; this or packageType is required.
    - integer
    - string
  - `organizationId` union: Global admins only; everyone else creates in their own organization.
    - integer
    - string
  - `monthlyReportsEnabled` boolean, nullable: Omit or null = package default.
  - `emailLanguage` 'de' | 'en' | 'da', nullable: Language of mails to this customer; null = organization language.
  - `customFields` object
  - `companyName` string, nullable
  - `notificationEmail` string, nullable
  - `notificationPhoneNumber` string, nullable
  - `notificationChannels` object, nullable: Deprecated per-customer channel switches; send null.
  - `allowSelfService` boolean, nullable
  - `maxSelfServiceUrls` union: null = package default.
    - integer
    - string
  - `canEditManaged` boolean
  - `enableEmailAlerts` boolean, nullable
  - `enableSmsAlerts` boolean, nullable
  - `enableWebhookAlerts` boolean, nullable
  - `enableIntegrationAlerts` boolean, nullable
  - `enablePostRequestEscalation` boolean, nullable

## Response `200`

OK

- object
  - `success` true, required
  - `customer` object, required
    - `id` integer, required
    - `publicId` string, uuid, required
    - `organizationId` integer, required
    - `name` string, required
    - `email` string, nullable, required
    - `notificationPhoneNumber` string, nullable, required
    - `notificationEmail` string, nullable, required
    - `emailLanguage` 'de' | 'en' | 'da', nullable, required: Language of mails to this customer; null = organization language.
    - `packageId` integer, nullable, required
    - `packageType` string, required
    - `status` 'active' | 'inactive', required
    - `allowedCheckCountryCodes` string[], nullable, required: ISO country codes of the allowed check locations; null = all.
    - `cancellationDate` string, date-time, nullable, required
    - `cancelledAt` string, date-time, nullable, required
    - `companyName` string, nullable, required
    - `flappingEnabled` boolean, required
    - `flappingIncidentCount` integer, required
    - `flappingWindowMinutes` integer, required
    - `flappingRecoveryCleanCycles` integer, required
    - `alertRepeatIntervalMinutes` integer, required
    - `customFields` object, nullable, required
    - `monthlyReportsEnabled` boolean, required
    - `notificationChannels` object, nullable, required: Deprecated.
    - `notificationTargets` object, nullable, required: Who receives each channel type; null = organization default.
    - `notificationRules` unknown, required
    - `allowSelfService` boolean, nullable, required: null = package default.
    - `maxSelfServiceUrls` integer, nullable, required: null = package default.
    - `canEditManaged` boolean, required
    - `enableEmailAlerts` boolean, nullable, required: null = package default.
    - `enableSmsAlerts` boolean, nullable, required: null = package default.
    - `enableWebhookAlerts` boolean, nullable, required: null = package default.
    - `enableIntegrationAlerts` boolean, nullable, required: null = package default.
    - `enablePostRequestEscalation` boolean, nullable, required: null = package default.
    - `smsUsageCurrentMonth` integer, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)