Revenue

Search mail

Search mail sends the words typed in the palette. The answer lists the closest mail first, with the subject, the other person's email, the kind of thread, why it matched, and how close it is. When mail search is not set up, the answer includes no matches.

get/v1/revenue-search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/revenue-search
  • Auth: HTTP bearer

Query parameters

qstring required

Words typed in Search mail.

Example:launch promise

Response

The mail Search mail ranks.

availableboolean

Whether mail search is set up.

Example response

{
  "available": true,
  "matches": [
    {
      "classification": "other",
      "counterparty": "client@example.org",
      "score": 0.9130171833009648,
      "subject": "Launch plan",
      "summary": "An explicit promise in this message needs confirmation.",
      "threadId": "tc"
    }
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.