Delete a Client Session

Delete a specified client session

Deletes a specified client session.

/client_sessions/delete

post
Authorizations
Body
client_session_idstring · uuidrequired
Responses
curl -L \
  --request POST \
  --url 'https://connect.getseam.com/client_sessions/delete' \
  --header 'Authorization: Bearer API Key' \
  --header 'Content-Type: application/json' \
  --data '{
    "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

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

Response

Returns a Boolean ok status indicator.

Sample Response

{ ok: true }

Last updated

Was this helpful?