Partners

Pick a name for a customer

Point the customer at one of your names, or null for your default. Takes effect once that name is live; until then the customer keeps seeing your default (or mx.faivelo.com). Requires partner:write.

put/customers/{id}/mail-host

Request

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

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

Request body

hoststring nullable required

Example request

{
  "host": "mail.clientco.com"
}

Response

The pick

successboolean

Example response

{
  "success": true
}

Changes

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