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_statusset toclosed - 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
Authorizations
Bearer token authentication using API tokens.
Include the token in the Authorization header as: Authorization: Bearer <token>
Obtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.
Path Parameters
The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.
"XqCmeTVgYXrbWrZFZEymkD"
Response
Session closed successfully
"Session closed successfully."
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.
ok, warning, error "ok"
Session response data. The formatted service address and normalized address components are returned in meta.
Session metadata, including normalized input values, formatted service address, session status, and the Hum data set used for the response.
