Create AdminAgentSessionParticipant

POST

api

sys

adminagentsessionparticipants

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/adminagentsessionparticipants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "AdminAgentSessionId": 123,
  "UserId": 123,
  "Role": 123,
  "Status": 123,
  "JoinedOn": "<string>"
}
'

import requests

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

payload = {
    "AdminAgentSessionId": 123,
    "UserId": 123,
    "Role": 123,
    "Status": 123,
    "JoinedOn": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    AdminAgentSessionId: 123,
    UserId: 123,
    Role: 123,
    Status: 123,
    JoinedOn: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessionparticipants', 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>"
    }
  ]
}

A person taking part in an admin agent conversation

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 AdminAgentSessionParticipant-Create role.

Request Body

Required Fields

integer

required

ID of the admin agent session.

integer

required

ID of the person taking part in the conversation.

integer

required

Owner (started the conversation) or Member (invited).

integer

required

Active, Left or Removed.

string

required

UTC time the person joined the conversation.

Optional Fields

integer

User who invited this person (null for the owner).

boolean

True when this person asked not to receive unread-message emails for this conversation.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/adminagentsessionparticipants" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "AdminAgentSessionId": 0,
    "UserId": 0,
    "Role": 0,
    "Status": 0,
    "JoinedOn": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      AdminAgentSessionId: 0,
      UserId: 0,
      Role: 0,
      Status: 0,
      JoinedOn: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/adminagentsessionparticipants',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'AdminAgentSessionId': 0,
        'UserId': 0,
        'Role': 0,
        'Status': 0,
        'JoinedOn': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the adminagentsessionparticipant was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "AdminAgentSessionParticipant was successfully created.",
  "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": "Role: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Role"
    }
  ],
  "WasSuccessful": false
}

Create AdminAgentSessionParticipant

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/adminagentsessionparticipants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "AdminAgentSessionId": 123,
  "UserId": 123,
  "Role": 123,
  "Status": 123,
  "JoinedOn": "<string>"
}
'

import requests

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

payload = {
    "AdminAgentSessionId": 123,
    "UserId": 123,
    "Role": 123,
    "Status": 123,
    "JoinedOn": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    AdminAgentSessionId: 123,
    UserId: 123,
    Role: 123,
    Status: 123,
    JoinedOn: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/sys/adminagentsessionparticipants', 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

Create AdminAgentSessionParticipant

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400