Skip to content

Releases: PostScanMail/api-examples

Release v1.1.0

07 Apr 15:39

Choose a tag to compare

v1.1.0 — Item Actions Examples + Expanded Coverage

This release expands the PostScan Mail Developer API examples to cover address-scoped item actions while keeping all v1.0.0 examples intact.

What’s new

Adds runnable examples (Node.js, Python, and cURL) for the following endpoints:

  • Open Items

    • POST /addresses/{address_id}/items/actions/open
    • POST /addresses/{address_id}/items/actions/open/cancel
  • Discard Items

    • POST /addresses/{address_id}/items/actions/discard
    • POST /addresses/{address_id}/items/actions/discard/cancel
  • Rescan Items

    • POST /addresses/{address_id}/items/actions/rescan
    • POST /addresses/{address_id}/items/actions/rescan/cancel
  • Shred Items

    • POST /addresses/{address_id}/items/actions/shred
    • POST /addresses/{address_id}/items/actions/shred/cancel

Still included (from v1.0.0)

  • GET /items
  • GET /user-defined-rules/system-user-defined-rules
  • PUT /user-defined-rules/update-system-user-defined-rule

Authentication & access

  • All requests require the x-api-key header.
  • API access is restricted to registered/authorized PostScan Mail accounts.
    For onboarding/support: api@postscanmail.com

Notes

  • Base URL: https://api.postscanmail.com/api/account-docs/v2/
  • Examples use environment variables and placeholders (no secrets should be committed).

Release v1.0.0

07 Apr 15:29

Choose a tag to compare

v1.0.0 — Initial Examples Release (Baseline)

This release contains the initial public code examples for the PostScan Mail Developer API.

Included examples

Mail Items: GET /items
Automation Status: GET /user-defined-rules/system-user-defined-rules
Automation Toggle: PUT /user-defined-rules/update-system-user-defined-rule

Authentication & access

All requests require the x-api-key header.
API access is restricted to registered/authorized PostScan Mail accounts.
Support: api@postscanmail.com