Partners

Add a domain

Add a domain to a customer on a plan; the domain is billed from the next sync. The response lists the DNS records to show them; there is no registrar auto-injection on this path. Poll the domain with verify=true until verified is true. Refused with 403 PARTNER_DOMAIN_LIMIT at your domain limit, which grows with clean sending. Requires partner:write.

post/customers/{id}/domains

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

Request body

domainstring required
brandNamestring nullable

Shown in the customer's webmail instead of the bare domain

plan'STARTER' | 'GROWTH' | 'PRO' | 'BUSINESS'

The plan this domain is billed at; it sets the storage shared by its mailboxes. Default: the customer's current plan

Example request

{
  "domain": "smiledental.example",
  "brandName": "Smile Dental"
}

Response

The domain with the records to publish

successboolean

Example response

{
  "success": true,
  "data": {
    "domain": "smiledental.example",
    "brandName": "Smile Dental",
    "dnsRecords": [
      {
        "type": "MX",
        "name": "smiledental.example",
        "value": "10 mx.faivelo.com"
      }
    ],
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

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