Partners

Create a mailbox key for a customer

Mints an account key on the customer for /api/v1/mailboxes/* from your own product: read, search and send mail in your UI without IMAP. Scopes default to the full mailbox vocabulary (mailboxes:read, mail:read, mail:send, mail:write), or mail:* only when bound to one mailbox. The plaintext comes back once. Refused on sandbox customers (no mail store) and suspended ones. Requires partner:write.

post/customers/{id}/api-keys

Request

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

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

Request body

namestring required
scopesstring[]

Defaults to everything allowed

mailboxAddressstring email

Bind the key to one mailbox on the customer

expiresInDaysinteger

Example request

{
  "name": "Acme inbox"
}

Response

The key, plaintext included once

successboolean

Example response

{
  "success": true,
  "data": {
    "name": "Acme inbox",
    "prefix": "fvl_live_a1b2c3",
    "scopes": [
      "mailboxes:read",
      "mail:read",
      "mail:send",
      "mail:write"
    ],
    "key": "fvl_live_..."
  }
}

Changes

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