AI-Powered Virtual Mailbox for Business | US Global Mail

Showing 25 of 36 from the live probe.

• List mail

  List the customer’s mail items with optional filters and cursor pagination. Returns { data, next_cursor, total_count }; pass next_cursor as `cursor` to page.

• Get mail

  Get a single mail item by id, including scan details.

• Mark mail read/unread

  Set the read status of a mail item.

• Move mail to folder

  Move a mail item into a folder by folder id.

• Mail: archive

  Request archive of a mail item.

• Mail: unarchive

  Request unarchive of a mail item.

• Mail: undiscard

  Request undiscard of a mail item.

• Discard mail

  Request discard (shredding) of a mail item. Destructive and hard to reverse — confirm with the user before calling.

• List folders

  List the customer’s mail folders. Returns { data }.

• Get folder

  Get a single folder by id.

• Create folder

  Create a mail folder.

• Update folder

  Rename or recolor a folder. Provide at least one field.

• Delete folder

  Delete a folder. Mail inside it is not deleted — it is unfiled (its folder is cleared). Destructive — confirm first.

• List scan requests

  List the customer’s scan/open requests with optional filters and cursor pagination. Returns { data, next_cursor, total_count }.

• Get scan request

  Get a single scan request by id.

• Get scan file URL

  Get a short-lived, signed download URL for a completed scan’s file. Returns { url, expires_at } — the file bytes are not proxied through the API.

• Get scan AI summary

  Get the AI-generated reading of a completed scan: a short label plus a bullet-point summary of the document contents. 404 when no summary exists (scan not completed yet, or the plan does not include labeling).

• Request a scan

  Request a scan (or open-and-scan) of a mail item. This is a billable action — confirm with the user first.

• Cancel scan request

  Cancel a pending scan request.

• Delete scan request

  Delete a scan request. Destructive — confirm first.

• List addresses

  List the customer’s shipping and deposit addresses. Returns { data, next_cursor, total_count }. Only shipping/deposit types are exposed.

• Get address

  Get a single address by id.

• Get default address

  Get the default address for a category (each of shipping/deposit has its own default).

• Create address

  Create a shipping or deposit address.

• Update address

  Partially update an address. Provide at least one field; omitted fields keep their current value.