Close Session

Explicitly closes an active session. While sessions automatically expire after inactivity, it’s best practice to close them when you’re done to free up resources.

Closing Behavior

All agent processing stops immediately
Cached results are cleared
Session token becomes invalid
Resources are freed

When to Close

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

Important Notes

Cannot be undone
New session required for same address
Final results should be saved before closing
Rate limits still apply

DELETE

sessions

{token}

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "street2": "A2",
      "city": "Southfield",
      "state": "MI",
      "zip": 48034,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "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"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact support@letshum.com for access.

Path Parameters

token

string

required

The session token identifying the specific session

Example:

"XqCmeTVgYXrbWrZFZEymkD"

Response

200

application/json

Session closed successfully

The response is of type object.

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "street2": "A2",
      "city": "Southfield",
      "state": "MI",
      "zip": 48034,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "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"
  }
}

Close Session

Explicitly closes an active session. While sessions automatically expire after inactivity, it’s best practice to close them when you’re done to free up resources.

Closing Behavior

All agent processing stops immediately
Cached results are cleared
Session token becomes invalid
Resources are freed

When to Close

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

Important Notes

Cannot be undone
New session required for same address
Final results should be saved before closing
Rate limits still apply

DELETE

sessions

{token}

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "street2": "A2",
      "city": "Southfield",
      "state": "MI",
      "zip": 48034,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "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"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact support@letshum.com for access.

Path Parameters

token

string

required

The session token identifying the specific session

Example:

"XqCmeTVgYXrbWrZFZEymkD"

Response

200

application/json

Session closed successfully

The response is of type object.

curl --request DELETE \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'

{
  "message": "Session closed successfully",
  "request_status": "ok",
  "data": {},
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "street2": "A2",
      "city": "Southfield",
      "state": "MI",
      "zip": 48034,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "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"
  }
}

Close Session

Closing Behavior

When to Close

Important Notes

Authorizations

Path Parameters

Response

Sessions

Service Availability

Health Check

Close Session

Closing Behavior

When to Close

Important Notes

Authorizations

Path Parameters

Response