Skip to content
StraventaDocs
Now in Sandbox.

Which notification emails the caller cannot switch off

GET
/v1/me/notification-email-locks

Maps event class to the reason the caller cannot fully switch its email off. Only events the caller's tenant-wide roles are actually emailed are listed (a merchant-scoped role receives no recon mail and so has no locks). Reasons: critical (catalogue-critical events always email), tenant_policy (a notification policy row for one of the caller's roles forbids opting out), escalation (email-off is honoured, but an escalated instance of the event is raised to critical and arrives anyway). Event classes absent from the map may be switched off and stay off. Requires no permission beyond a signed-in tenant context.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT Bearer access token. Clock skew tolerance is ±60 seconds.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://sandbox.505pay.link/v1/me/notification-email-locks"
{
  "email_locked": {
    "recon.disbursement.failed": "critical",
    "recon.exception.aged": "tenant_policy"
  }
}
{
  "error": "unauthenticated",
  "message": "missing or invalid bearer token",
  "request_id": "req_01abc123"
}
{
  "error": "rate_limited",
  "message": "too many requests",
  "request_id": "req_01abc127"
}

Was this page helpful?