Partners

Create a customer

Create an end customer. The customer gets no password and no dashboard by design; you operate the account through this API and they use the webmail. Both attestation flags must be true. Refused with 403 while your partner account is paused or the customer cap is reached. Requires partner:write.

post/customers

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers
  • Auth: HTTP bearer

Request body

emailstring email required
namestring nullable
companyNamestring nullable
plan'STARTER' | 'GROWTH' | 'PRO' | 'BUSINESS'

The plan the customer's domains take when you add them without one. Defaults to your partner account's default plan

Example request

{
  "email": "owner@smiledental.example",
  "companyName": "Smile Dental"
}

Response

The new customer

successboolean

Example response

{
  "success": true,
  "data": {
    "id": "cmtumr8yj000bd7xabjjsnil8",
    "email": "owner@smiledental.example",
    "name": "Dana Levi",
    "companyName": "Smile Dental",
    "domains": 1,
    "mailboxes": 4
  }
}

Changes

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