Sessions

Close Session

Closes an active session. Sessions remain open until this endpoint is called.

Closing Behavior

The response returns the session envelope with meta.session_status set to closed
Subsequent operations on the closed session return HTTP 410

When to Close

After completing service lookup
When switching to a different address
After receiving final results
When abandoning a search

Important Notes

A closed session cannot be reopened
Create a new session to perform another lookup

delete/sessions/{token}

Response

Session closed successfully

messagestring required

request_status'ok' | 'warning' | 'error' required

An informational summary returned in API response bodies: ok for successful responses, warning for standard request errors, and error for endpoint-specific failures. Integrations must use the HTTP status code, not request_status, to determine whether a request succeeded.

Example response

{
  "message": "Session closed successfully.",
  "request_status": "ok",
  "data": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD"
  },
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Dr E",
      "city": "Southfield",
      "state": "MI",
      "zip": "48034",
      "latitude": "42.50189",
      "longitude": "-83.29528"
    },
    "service_address": "1420 Washington Blvd, Detroit, MI 48201",
    "created_at": "2024-09-20T23:13:31.179Z",
    "updated_at": "2024-09-20T23:13:31.179Z",
    "responded_at": "2024-09-20T23:13:31.179Z",
    "hum_data_set": "25041808"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.