Delete a Client Session

Delete a specified client session

Deletes a specified client session.

/client_sessions/delete

post

Deletes a client session.

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

Body

client_session_idstring · uuidRequired

ID of the client session that you want to delete.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /client_sessions/delete HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Key
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "client_session_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "ok": true
}

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 }