Expire a session
Mark an unfinished session as expired.
Overview
Close a session through the expiry path. The operation records an expiry event, removes its calendar entry, and cancels applicable email alerts. Use cancellation when you need cancellation-specific reasons and participant notifications.
The session belongs to this vendor. The session is not already expired or completed.
- Check the current state
Avoid expiring a completed or already expired session.
- Mark expired
Call the endpoint without a body.
- Record the outcome
Update your application and handle the expiry event.
Parameters
| Field | Requirement | Description |
|---|---|---|
bn_session_idstring · path | Required | The session to expire. No request body is required. |
Request example
Use a server-side API key. Replace example IDs and values before using this request in an approved test environment.
curl --request PUT \
--url 'https://app.bluenotary.us/api/integrationsv2/sessions/YOUR_SESSION_ID/markExpired' \
--header "Authorization: Bearer $BLUENOTARY_API_KEY"Response
200 · Example success Illustrative values in the current response shape.
{
"response": "Success",
"response_message": "Session marked as expired."
}- Expiry emits
session_expired. Expired-session access and participant handling belong to the expiry workflow. - Expiry transitions from cancelled or terminated states are not a supported integration contract. Check the current state and avoid these transitions.
- No reopen operation is registered in this v2 surface. Do not present expiry as a reversible toggle.
- A repeated expiry request returns an error rather than the same success envelope.
Errors & recovery
| Status | What happened | What to do |
|---|---|---|
| 400 | Completed Session cannot be marked as expired | Keep the completed record and retrieve its artifacts instead. |
| 400 | Session already expired | Treat the known expired state as the outcome; do not keep retrying. |
| 403 | Session Not Found | Check the session ID and vendor ownership. |
Explore the response
Response simulator
LOCAL EXAMPLEExplore the example response without an API key. This does not send requests or validate your account configuration.
This example uses the resource ID shown in the endpoint path.