Delete a Client Session

Delete a specified client session

Deletes a specified client session.

/client_sessions/delete

POSThttps://connect.getseam.com/client_sessions/delete

Authorization

api_keypat_with_workspaceconsole_session_with_workspace

Body

application/json

client_session_id*string (uuid)

Response

200400401

OK

Body

application/json

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/client_sessions/delete', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "client_session_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "ok": false
}

Request

Specify the desired client session by including the corresponding client_session_id in the request body.

Request Body Parameters

Parameter	Type	Description
client_session_id	String Required	ID of the desired client session

Sample Request

JavaScript

await seam.clientSessions.delete({
  client_session_id: "639eb8af-19a9-4ae5-817c-6ad08fd078e7",
})

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{ ok: true }