---
title: "Mint a webmail sign-in link"
method: POST
path: "/customers/{id}/domains/{domain}/mailboxes/{address}/webmail-session"
tags: ["Partners"]
---

# Mint a webmail sign-in link

`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

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`.

## Path parameters

- `id` string, required
- `domain` string, required
- `address` string, required

## Response `201`

The sign-in link

- object
  - `success` boolean
  - `data` PartnerWebmailSession
    - `url` string, uri: Send the browser here; it signs in and lands in the inbox
    - `expiresAt` string, date-time

## Other responses

- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `409`: The mailbox is inactive
- `429`: Rate limit exceeded

---

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