API referenceDocument Intelligence

Get or create the organization's inbound email address

posthttps://api.expiryedge.com/v1/setupInboundEmail
admin60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/setupInboundEmail' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "success": true,
  "inbound_email": "docs-northwind-dental-k3x9qa@inbound.expiryedge.com",
  "slug": "northwind-dental-k3x9qa",
  "enabled": true
}

Documents emailed to this address are scanned and turned into expiries. The first call generates a random slug; later calls return the same address.

Returns

200
Inbound address.
  • successboolean
  • inbound_emailstring
    format: email
  • slugstring
  • enabledboolean

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.