Update AdminAgentSession

PUT

api

sys

adminagentsessions

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/adminagentsessions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "UserId": 123,
  "Channel": 123,
  "StartedOn": "<string>",
  "LastActivityOn": "<string>",
  "Status": 123,
  "Mode": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "UserId": 123,
    "Channel": 123,
    "StartedOn": "<string>",
    "LastActivityOn": "<string>",
    "Status": 123,
    "Mode": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    UserId: 123,
    Channel: 123,
    StartedOn: '<string>',
    LastActivityOn: '<string>',
    Status: 123,
    Mode: 123
  })
};

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

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

Updates an existing AdminAgentSession record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Request Body

Required Fields

integer

required

The Id of the AdminAgentSession record to update.

integer

required

The business property.

integer

required

The user property.

integer

required

The channel property.

string

required

The startedon property.

string

required

The lastactivityon property.

integer

required

The status property.

integer

required

Default routing of messages: Agent (assistant answers everything) or Chat (people talk, the assistant only answers when mentioned).

Optional Fields

string

The sessionid property.

string

The title property.

string

The metadata property.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/adminagentsessions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "UserId": 0,
    "Channel": 0,
    "StartedOn": "2025-01-15T10:30:00Z",
    "LastActivityOn": "2025-01-15T10:30:00Z",
    "Status": 0,
    "Mode": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessions',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      UserId: 0,
      Channel: 0,
      StartedOn: '2025-01-15T10:30:00Z',
      LastActivityOn: '2025-01-15T10:30:00Z',
      Status: 0,
      Mode: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/sys/adminagentsessions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'UserId': 0,
        'Channel': 0,
        'StartedOn': '2025-01-15T10:30:00Z',
        'LastActivityOn': '2025-01-15T10:30:00Z',
        'Status': 0,
        'Mode': 0,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the adminagentsession was updated successfully.

array

null on success.

Example Response

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

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Channel: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Channel"
    }
  ],
  "WasSuccessful": false
}

Update AdminAgentSession

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/adminagentsessions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "UserId": 123,
  "Channel": 123,
  "StartedOn": "<string>",
  "LastActivityOn": "<string>",
  "Status": 123,
  "Mode": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "BusinessId": 123,
    "UserId": 123,
    "Channel": 123,
    "StartedOn": "<string>",
    "LastActivityOn": "<string>",
    "Status": 123,
    "Mode": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    UserId: 123,
    Channel: 123,
    StartedOn: '<string>',
    LastActivityOn: '<string>',
    Status: 123,
    Mode: 123
  })
};

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

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400