Partners

Mint a webmail sign-in link

A link that signs the browser into this mailbox's webmail without a password, for a portal whose user is already authenticated: redirect them to url. The link lives two minutes and works once; a second visit lands on the login page. It opens on the domain's own webmail host when it has one (your brand), else on mail.faivelo.com. Every link is on the customer's audit trail. Refused on sandbox customers (no webmail) and inactive mailboxes (409). There is deliberately no endpoint that checks a mailbox password: use this link instead. Requires partner:write.

post/customers/{id}/domains/{domain}/mailboxes/{address}/webmail-session

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}/webmail-session
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

addressstring required

Full mailbox address, URL-encoded, e.g. hello%40smiledental.example

Response

The sign-in link

successboolean

Example response

{
  "success": true,
  "data": {
    "url": "https://smiledental.faivelo.com/api/webmail/auth/sso?token=eyJ..."
  }
}

Changes

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