Lists

Replace lists

Makes each list named in the body exactly the entries given. Lists not named are left as they are; an empty array clears a list. Requires scope mailboxes:write on an account key: agent keys, OAuth connections and single-mailbox keys can read the lists but not change them, so software cannot loosen its own guardrail.

put/mailboxes/{address}/lists

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/lists
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

Request body

Example request

{
  "receive": {
    "allow": [
      "acme.com"
    ]
  },
  "send": {
    "block": [
      "competitor.com"
    ]
  }
}

Response

All four lists as they stand now

successboolean

Example response

{
  "success": true,
  "data": {
    "send": {
      "allow": [
        "acme.com",
        "ceo@partner.io"
      ],
      "block": [
        "spammer.com"
      ]
    },
    "receive": {
      "allow": [
        "acme.com",
        "ceo@partner.io"
      ],
      "block": [
        "spammer.com"
      ]
    }
  }
}

Changes

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