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.
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.
Session metadata, including normalized input values, formatted service address, session status, and the Hum data set used for the response.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Hum Documentation","colors":{"primary":"#2a77fa","light":"#F1F5F9","dark":"#0c76f9"},"logo":{"light":"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/logo/hum.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=8bd29d065c4bb046f4c7c7f49da36bbb","dark":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/logo/hum_white.png?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=3827bdfbb39a028c883c7893813b1b64"},"favicon":"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/favicon.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=dff27db0a310e983c60e337475bafbc7","background":{"image":{"light":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/images/main-bg_home.svg?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=4f5502fc6992ad9135f88385a79089a8","dark":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/images/main-bg_home.svg?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=4f5502fc6992ad9135f88385a79089a8"},"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"mailto:support@letshum.com","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://letshum.com/contact"}},"footer":{"socials":{"github":"https://github.com/letshum","linkedin":"https://www.linkedin.com/company/letshum"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://letshum.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@letshum.com"},{"anchor":"Operational Status","icon":"chart-simple","href":"https://status.letshum.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hum","hasAudioNarration":false,"actualSubdomain":"hum","customDomains":["docs.letshum.com"],"gitSource":{"type":"github","owner":"letshum","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae75b4bc064cc679ecfa937","collectionId":"e5bcad6b-cfc5-44f7-af3c-03b5e42387c7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae75b4bc064cc679ecfa937"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae75b4bc064cc679ecfa937","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"MCP","count":7},{"language":"default","tag":"Hum Broadband MCP","count":7},{"language":"default","tag":"Integration","count":6},{"language":"default","tag":"Widget Integration","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Sessions","count":3},{"language":"default","tag":"Analytics","count":2},{"language":"default","tag":"Health Check","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sessions/close-session","slug":"/api-reference/sessions/close-session","pageMetadata":{"title":"Close Session","description":"Closes an active session. Sessions remain open until this endpoint is called.\n\n## Closing Behavior\n- The response returns the session envelope with `meta.session_status` set to `closed`\n- Subsequent operations on the closed session return HTTP 410\n\n## When to Close\n- After completing service lookup\n- When switching to a different address\n- After receiving final results\n- When abandoning a search\n\n## Important Notes\n- A closed session cannot be reopened\n- Create a new session to perform another lookup\n","deprecated":null,"version":null,"openapi":"/swagger.yaml delete /sessions/{token}","href":"/api-reference/sessions/close-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Closes an active session. Sessions remain open until this endpoint is called.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Closing Behavior\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"The response returns the session envelope with \", _jsx(_components.code, {\n children: \"meta.session_status\"\n }), \" set to \", _jsx(_components.code, {\n children: \"closed\"\n })]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Subsequent operations on the closed session return HTTP 410\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"When to Close\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"After completing service lookup\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"When switching to a different address\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"After receiving final results\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"When abandoning a search\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Important Notes\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"A closed session cannot be reopened\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Create a new session to perform another lookup\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Close Session","description":"Closes an active session. Sessions remain open until this endpoint is called.\n\n## Closing Behavior\n- The response returns the session envelope with `meta.session_status` set to `closed`\n- Subsequent operations on the closed session return HTTP 410\n\n## When to Close\n- After completing service lookup\n- When switching to a different address\n- After receiving final results\n- When abandoning a search\n\n## Important Notes\n- A closed session cannot be reopened\n- Create a new session to perform another lookup\n","deprecated":null,"version":null,"openapi":"/swagger.yaml delete /sessions/{token}","href":"/api-reference/sessions/close-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"closeSession","security":["7fd0dd1a-f699-4d16-881a-842498bd4b3e"],"tags":["Sessions"],"summary":"Close Session","description":"Closes an active session. Sessions remain open until this endpoint is called.\n\n## Closing Behavior\n- The response returns the session envelope with `meta.session_status` set to `closed`\n- Subsequent operations on the closed session return HTTP 410\n\n## When to Close\n- After completing service lookup\n- When switching to a different address\n- After receiving final results\n- When abandoning a search\n\n## Important Notes\n- A closed session cannot be reopened\n- Create a new session to perform another lookup\n","responses":{"200":"6d3be5b8-0298-4f61-8bec-eca0fbd2b58e","400":"8a45696b-cd58-4255-aa18-e983a553dd09","401":"3436f358-8ffa-4008-b5dc-d7c493914b80","410":"208b2613-1b7c-497c-a756-ed1dfb455818","415":"4675292b-d38b-4c68-9c70-1645dea43ac2","422":"15f30c5f-fc70-40af-a6bb-7461872f73c8","429":"271ea123-429e-4154-9c19-75e0a2b4a129","500":"dae5b2bb-f133-4a38-a904-172205a1d656"},"method":"delete","type":"path","servers":["a0fb7d8d-c46d-46cf-b53e-90b496207a53","50a481b3-b8e5-4d61-b045-e37902a020f0"],"path":"/sessions/{token}","baseUrlOptions":["https://api-sandbox.letshum.com","https://api.letshum.com"],"title":"Close Session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fff1c915-211a-4796-85c0-1f4f96795529":{"name":"token","in":"path","required":true,"schema":{"type":"string","example":"XqCmeTVgYXrbWrZFZEymkD","description":"The session token identifying the specific session\nThe session token provided by the Hum API. Used to connect the response to the session in the client system.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The session token identifying the specific session"}},"responses":{"6d3be5b8-0298-4f61-8bec-eca0fbd2b58e":{"description":"Session closed successfully","headers":{"session_token":{"description":"The session token provided by the Hum API. Used to connect the response to the session in the client system.","required":true,"schema":{"type":"string"},"example":"XqCmeTVgYXrbWrZFZEymkD"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Session closed successfully.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["ok","warning","error"],"example":"ok","description":"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.\n","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"session_token":{"type":"string","example":"XqCmeTVgYXrbWrZFZEymkD","description":"The session token provided by the Hum API. Used to connect the response to the session in the client system.","isRequired":true,"uniqueKey":"data.session_token","typeLabel":"string"}},"required":["session_token"],"description":"Session response data. The formatted service address and normalized address components are returned in `meta`.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"session_token":{"type":"string","example":"XqCmeTVgYXrbWrZFZEymkD","description":"The session token provided by the Hum API. Used to connect the response to the session in the client system.","isRequired":true,"uniqueKey":"meta.session_token","typeLabel":"string"},"session_status":{"type":"string","enum":["open","closed"],"example":"open","description":"The status of the session.","isRequired":true,"uniqueKey":"meta.session_status","typeLabel":"enum\u003cstring>"},"agent_status":{"type":"object","properties":{"geocoding":{"type":"string","enum":["pending","matched","multiple","failed"],"example":"matched","description":"The status of the geocoding agent. Pending: The agent has not yet processed the address. Matched: The agent has found a single match for the address. Multiple: The agent has found multiple matches for the address. Failed: The agent was unable to match the address.","uniqueKey":"meta.agent_status.geocoding","typeLabel":"enum\u003cstring>"},"internet":{"type":"string","enum":["pending","matched","failed"],"example":"matched","description":"The status of the Internet service availability agent. Pending: The agent has not yet processed the address. Matched: The agent has found Internet service providers for the address. Failed: The agent was unable to find Internet service providers for the address.","uniqueKey":"meta.agent_status.internet","typeLabel":"enum\u003cstring>"},"checkout":{"type":"string","enum":["pending"],"example":"pending","description":"The status of the checkout agent. Pending: The agent has not yet begun processing a checkout for service. ","uniqueKey":"meta.agent_status.checkout","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"meta.agent_status","typeLabel":"object"},"session_params":{"type":"object","description":"Address and campaign values after normalization. Coordinate values are serialized as strings in response metadata.","properties":{"street1":{"type":"string","example":"29090 Tiffany Dr E","isRequired":true,"uniqueKey":"meta.session_params.street1","typeLabel":"string"},"street2":{"oneOf":[{"type":"string","example":null,"isRequired":true,"uniqueKey":"meta.session_params.street2.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"isRequired":true,"uniqueKey":"meta.session_params.street2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.session_params.street2","typeLabel":"string | null"},"city":{"type":"string","example":"Southfield","isRequired":true,"uniqueKey":"meta.session_params.city","typeLabel":"string"},"state":{"type":"string","example":"MI","isRequired":true,"uniqueKey":"meta.session_params.state","typeLabel":"string"},"zip":{"type":"string","example":"48034","isRequired":true,"uniqueKey":"meta.session_params.zip","typeLabel":"string"},"latitude":{"oneOf":[{"type":"string","example":"42.50189","isRequired":true,"uniqueKey":"meta.session_params.latitude.oneOf.0","typeLabel":"string"},{"type":"null","example":"42.50189","isRequired":true,"uniqueKey":"meta.session_params.latitude.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.session_params.latitude","typeLabel":"string | null"},"longitude":{"oneOf":[{"type":"string","example":"-83.29528","isRequired":true,"uniqueKey":"meta.session_params.longitude.oneOf.0","typeLabel":"string"},{"type":"null","example":"-83.29528","isRequired":true,"uniqueKey":"meta.session_params.longitude.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.session_params.longitude","typeLabel":"string | null"},"campaign_id":{"oneOf":[{"type":"string","example":null,"isRequired":true,"uniqueKey":"meta.session_params.campaign_id.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"isRequired":true,"uniqueKey":"meta.session_params.campaign_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meta.session_params.campaign_id","typeLabel":"string | null"}},"required":["street1","street2","city","state","zip","latitude","longitude","campaign_id"],"isRequired":true,"uniqueKey":"meta.session_params","typeLabel":"object"},"service_address":{"type":"string","example":"1420 Washington Blvd, Detroit, MI 48201","description":"The complete service address as a single string.","isRequired":true,"uniqueKey":"meta.service_address","typeLabel":"string"},"mdu":{"type":"boolean","example":false,"description":"Whether the normalized service address is a multi-dwelling unit.","isRequired":true,"uniqueKey":"meta.mdu","typeLabel":"boolean"},"created_at":{"type":"string","description":"The timestamp when the session was created.","format":"date-time","example":"2024-09-20T23:13:31.179Z","isRequired":true,"uniqueKey":"meta.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","description":"The timestamp when the session was last updated.","format":"date-time","example":"2024-09-20T23:13:31.179Z","isRequired":true,"uniqueKey":"meta.updated_at","typeLabel":"string\u003cdate-time>"},"responded_at":{"type":"string","description":"The timestamp when the response was generated.","format":"date-time","example":"2024-09-20T23:13:31.179Z","isRequired":true,"uniqueKey":"meta.responded_at","typeLabel":"string\u003cdate-time>"},"hum_data_set":{"type":"string","pattern":"^\\d+$","example":"25041808","description":"The version of the Hum data set used to generate the response. This version may change as the data set is updated.","isRequired":true,"uniqueKey":"meta.hum_data_set","typeLabel":"string"}},"required":["session_token","session_status","session_params","service_address","mdu","agent_status","created_at","updated_at","responded_at","hum_data_set"],"description":"Session metadata, including normalized input values, formatted service address, session status, and the Hum data set used for the response.","isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["message","request_status","data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Session closed successfully.","request_status":"ok","data":{"session_token":"SESSION_TOKEN_PLACEHOLDER"},"meta":{"session_token":"SESSION_TOKEN_PLACEHOLDER","session_status":"closed","session_params":{"street1":"29090 Tiffany Dr E","street2":null,"city":"Southfield","state":"MI","zip":"48034","latitude":"42.50189","longitude":"-83.29528","campaign_id":null},"service_address":"29090 Tiffany Dr E, Southfield, MI 48034-4540","mdu":false,"agent_status":{"geocoding":"matched","internet":"matched","checkout":"pending"},"created_at":"2026-07-13T12:26:15.618-04:00","updated_at":"2026-07-13T12:27:33.031-04:00","responded_at":"2026-07-13T16:27:33.185Z","hum_data_set":"26011015"}},"examples":{"Example":{"title":"Example","value":{"message":"Session closed successfully.","request_status":"ok","data":{"session_token":"SESSION_TOKEN_PLACEHOLDER"},"meta":{"session_token":"SESSION_TOKEN_PLACEHOLDER","session_status":"closed","session_params":{"street1":"29090 Tiffany Dr E","street2":null,"city":"Southfield","state":"MI","zip":"48034","latitude":"42.50189","longitude":"-83.29528","campaign_id":null},"service_address":"29090 Tiffany Dr E, Southfield, MI 48034-4540","mdu":false,"agent_status":{"geocoding":"matched","internet":"matched","checkout":"pending"},"created_at":"2026-07-13T12:26:15.618-04:00","updated_at":"2026-07-13T12:27:33.031-04:00","responded_at":"2026-07-13T16:27:33.185Z","hum_data_set":"26011015"}}}},"exampleType":"examples"}},"exampleType":"examples"},"8a45696b-cd58-4255-aa18-e983a553dd09":{"description":"Bad request. This includes an invalid session token. Use the HTTP status code, not `request_status`, to detect the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_parameters":{"title":"invalid_parameters","value":{"message":"Invalid parameters sent to session.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}},"invalid_session_token":{"title":"invalid_session_token","value":{"message":"Invalid session token.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"3436f358-8ffa-4008-b5dc-d7c493914b80":{"description":"Unauthorized. Use the HTTP status code, not `request_status`, to detect the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthorized access","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized access","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"208b2613-1b7c-497c-a756-ed1dfb455818":{"description":"The session has been closed. Use the HTTP status code, not `request_status`, to detect the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Session is closed. Please open a new session.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Session is closed. Please open a new session.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"4675292b-d38b-4c68-9c70-1645dea43ac2":{"description":"The request was rejected because its content type is unsupported.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Request rejected","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The request was rejected due to security concerns","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"integer","enum":[415],"example":415,"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cinteger>"}},"required":["error","message","status"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Request rejected","message":"The request was rejected due to security concerns","status":415}}},"exampleType":"generated"}},"exampleType":"generated"},"15f30c5f-fc70-40af-a6bb-7461872f73c8":{"description":"Session validation failed. Use the HTTP status code, not `request_status`, to detect the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Session could not be created.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","errors":{"base":["Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)"]}},"examples":{"Example":{"title":"Example","value":{"message":"Session could not be created.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","errors":{"base":["Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"271ea123-429e-4154-9c19-75e0a2b4a129":{"description":"Rate Limit Exceeded","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":60,"required":true}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Rate limit exceeded. Please try again later.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Rate limit exceeded. Please try again later.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"dae5b2bb-f133-4a38-a904-172205a1d656":{"description":"Unexpected internal error handled by an API controller.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Internal server error","request_status":"error","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error","request_status":"error","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7fd0dd1a-f699-4d16-881a-842498bd4b3e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","scopes":[]}}},"servers":{"a0fb7d8d-c46d-46cf-b53e-90b496207a53":{"url":"https://api-sandbox.letshum.com","description":"Sandbox environment"},"50a481b3-b8e5-4d61-b045-e37902a020f0":{"url":"https://api.letshum.com","description":"Production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"swagger.yaml"},"subdomain":"hum","siteName":"Hum Documentation","title":"Close Session - Hum Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-13T23:37:37.558Z","originalFileLocation":"api-reference/sessions/close-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hum Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Close Session - Hum Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hum Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.letshum.com/api-reference/sessions/close-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hum.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Close+Session\u0026amp;description=Closes+an+active+session.+Sessions+remain+open+until+this+endpoint+is+called.%0A%0A%23%23+Closing+Behavior%0A-+The+response+returns+the+session+envelope+with+%60meta.sessio\u0026amp;theme=681961f9c74f9e589caf8b82\u0026amp;signature=450253c9e10acd07f1258c1230e1968d922178522f0a651a97f0d3f456333686\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Close Session - Hum Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hum.mintlify.app/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Close+Session\u0026amp;description=Closes+an+active+session.+Sessions+remain+open+until+this+endpoint+is+called.%0A%0A%23%23+Closing+Behavior%0A-+The+response+returns+the+session+envelope+with+%60meta.sessio\u0026amp;theme=681961f9c74f9e589caf8b82\u0026amp;signature=450253c9e10acd07f1258c1230e1968d922178522f0a651a97f0d3f456333686\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hum Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2a77fa\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.letshum.com/api-reference/sessions/close-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/close-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.letshum.com/#organization\",\"name\":\"Hum Documentation\",\"url\":\"https://docs.letshum.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/logo/hum.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=8bd29d065c4bb046f4c7c7f49da36bbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.letshum.com#website\",\"name\":\"Hum Documentation\",\"url\":\"https://docs.letshum.com\",\"publisher\":{\"@id\":\"https://docs.letshum.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.letshum.com/api-reference/sessions/close-session#webpage\",\"url\":\"https://docs.letshum.com/api-reference/sessions/close-session\",\"name\":\"Close Session\",\"description\":\"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\",\"dateModified\":\"2026-08-13T23:37:37.558Z\",\"isPartOf\":{\"@id\":\"https://docs.letshum.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.letshum.com/api-reference/sessions/close-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.letshum.com/api-reference/sessions/close-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessions\",\"item\":\"https://docs.letshum.com/api-reference/sessions/create-new-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Close Session\",\"item\":\"https://docs.letshum.com/api-reference/sessions/close-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.letshum.com/api-reference/sessions/close-session#apireference\",\"headline\":\"Close Session\",\"name\":\"Close Session\",\"description\":\"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\",\"url\":\"https://docs.letshum.com/api-reference/sessions/close-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.letshum.com/api-reference/sessions/close-session#webpage\"},\"dateModified\":\"2026-08-13T23:37:37.558Z\",\"publisher\":{\"@id\":\"https://docs.letshum.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.letshum.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hum Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hum Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://letshum.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@letshum.com"},{"anchor":"Operational Status","icon":"chart-simple","href":"https://status.letshum.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Sessions","pages":[{"title":"Create New Session","deprecated":null,"version":null,"openapi":"/swagger.yaml post /sessions","href":"/api-reference/sessions/create-new-session"},{"title":"Get Session Status","description":"Retrieves an open session. Provider results are usually returned by `POST /sessions`, but when `qualify_status` is `pending` or `retry_later`, poll `GET /sessions/{token}/services/internet` until the status resolves.\n\n## Status Codes\n- 200: Session is open\n- 400: Session token is invalid\n- 410: Session is closed\n\n## Response Data\n- `data.session_token`: The session token only\n- `meta.session_params`: Normalized address values\n- `meta.service_address`: Formatted service address\n- `meta.agent_status`: Agent status values\n\n## Important Notes\n- The session token is part of the URL path for all requests after creation\n- Sessions remain open until they are closed with DELETE\n\n## Example Response\n```json\n{\n \"message\": \"Session agents have successfully matched the service address. Please proceed.\",\n \"request_status\": \"ok\",\n \"data\": {\n \"session_token\": \"SESSION_TOKEN_PLACEHOLDER\"\n },\n \"meta\": {\n \"session_token\": \"SESSION_TOKEN_PLACEHOLDER\",\n \"session_status\": \"open\",\n \"session_params\": {\n \"street1\": \"29090 Tiffany Dr E\",\n \"street2\": \"Apt 4B\",\n \"city\": \"Southfield\",\n \"state\": \"MI\",\n \"zip\": \"48034\",\n \"latitude\": \"42.50189\",\n \"longitude\": \"-83.29528\",\n \"campaign_id\": null\n },\n \"service_address\": \"29090 Tiffany Dr E Apt 4B, Southfield, MI 48034-4540\",\n \"mdu\": true,\n \"agent_status\": {\n \"geocoding\": \"matched\",\n \"internet\": \"matched\",\n \"checkout\": \"pending\"\n },\n \"created_at\": \"2026-07-13T12:26:15.618-04:00\",\n \"updated_at\": \"2026-07-13T12:26:15.618-04:00\",\n \"responded_at\": \"2026-07-13T16:26:16.900Z\",\n \"hum_data_set\": \"26011015\"\n }\n}\n```\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /sessions/{token}","href":"/api-reference/sessions/get-session-status"},{"title":"Close Session","deprecated":null,"version":null,"openapi":"/swagger.yaml delete /sessions/{token}","href":"/api-reference/sessions/close-session"}]},{"group":"Service Availability","pages":[{"title":"Get Internet Service Availability","description":"Retrieves available Internet service providers and their offerings for the service address associated with \nthe current session.\n\n## Data Provided\n- Internet Service Providers (ISPs)\n- Available plans and pricing\n- Technology types (Fiber, Cable, DSL, etc.)\n- Maximum speeds\n- Provider contact information\n- Checkout URLs\n\n## Data Freshness\nProvider and product data comes from the current Hum data set identified by `meta.hum_data_set`.\n\n## Example Response\n```json\n{\n \"message\": \"Service coverage for 29090 TIFFANY DR E, SOUTHFIELD, MI 48034\",\n \"request_status\": \"ok\",\n \"data\": [\n {\n \"provider_id\": \"130317\",\n \"provider_name\": \"Xfinity\",\n \"telephone\": \"+18332981431\",\n \"provider_icon\": null,\n \"provider_logo\": \"https://cdn.example.com/providers/xfinity-logo.png\",\n \"url\": \"https://affiliate.example.com/xfinity?session=SESSION_TOKEN\",\n \"button_label\": \"xfinity.com\",\n \"min_plan_price\": {\n \"amount_cents\": 4000,\n \"currency\": \"USD\"\n },\n \"provider_promo\": {},\n \"url_promo\": {},\n \"offerings\": [\n {\n \"technology\": \"Cable\",\n \"max_download_speed\": 1200,\n \"max_upload_speed\": 35\n }\n ],\n \"product_catalog\": []\n }\n ],\n \"meta\": {\n \"session_token\": \"SESSION_TOKEN_PLACEHOLDER\",\n \"session_status\": \"open\",\n \"session_params\": {\n \"street1\": \"29090 Tiffany Dr E\",\n \"street2\": null,\n \"city\": \"Southfield\",\n \"state\": \"MI\",\n \"zip\": \"48034\",\n \"latitude\": \"42.50189\",\n \"longitude\": \"-83.29528\",\n \"campaign_id\": null\n },\n \"service_address\": \"29090 Tiffany Dr E, Southfield, MI 48034-4540\",\n \"mdu\": false,\n \"agent_status\": {\n \"geocoding\": \"matched\",\n \"internet\": \"matched\",\n \"checkout\": \"pending\"\n },\n \"created_at\": \"2026-07-13T12:26:15.618-04:00\",\n \"updated_at\": \"2026-07-13T12:26:15.618-04:00\",\n \"responded_at\": \"2026-07-13T16:26:17.471Z\",\n \"hum_data_set\": \"26011015\"\n }\n}\n```\n\nNote: Some providers may return an empty `product_catalog` array.\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /sessions/{token}/services/internet","href":"/api-reference/service-availability/get-internet-service-availability"}]},{"group":"Health Check","pages":[{"title":"API Health Check","deprecated":null,"version":null,"openapi":"/swagger.yaml get /ping","href":"/api-reference/health-check/api-health-check"}]},{"group":"Informational","pages":[{"title":"Get FCC Service Providers","deprecated":null,"version":null,"openapi":"/swagger.yaml get /service_providers","href":"/api-reference/informational/get-fcc-service-providers"}]},{"group":"Analytics","pages":[{"title":"List Sessions","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions","href":"/api-reference/analytics/list-sessions"},{"title":"Get Session Detail","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions/{id}","href":"/api-reference/analytics/get-session-detail"}]}]}]},"basePath":"","title":"Close Session - Hum Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}