Delete AdminAgentSession

DELETE

api

sys

adminagentsessions

{id}

Delete AdminAgentSession

curl --request DELETE \
  --url https://spaces.nexudus.com/api/sys/adminagentsessions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": {},
  "WasSuccessful": true,
  "Errors": [
    {}
  ]
}

Deletes a AdminAgentSession record. Once deleted, the record is permanently removed from the system.

This action is permanent and cannot be undone. Consider updating the record instead if you want to preserve its history.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the AdminAgentSession-Delete role.

Path Parameters

integer

required

The Id of the AdminAgentSession record to delete.

Code Examples

curl -X DELETE \
  "https://spaces.nexudus.com/api/sys/adminagentsessions/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessions/87654321',
  {
    method: 'DELETE',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.delete(
    'https://spaces.nexudus.com/api/sys/adminagentsessions/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the deletion.

object

Contains the Id of the deleted record.

boolean

true if the deletion was successful.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "AdminAgentSession was successfully deleted.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T12:00:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

500

Example Response

{
  "Status": 500,
  "Message": "An error occurred while deleting the record.",
  "Value": null,
  "RedirectURL": null,
  "UpdatedOn": null,
  "UpdatedBy": null,
  "Errors": null,
  "WasSuccessful": false
}

Delete AdminAgentSession

curl --request DELETE \
  --url https://spaces.nexudus.com/api/sys/adminagentsessions/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/adminagentsessions/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": {},
  "WasSuccessful": true,
  "Errors": [
    {}
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

500