Create OpenAiChatMessage

POST

api

sys

openaichatmessages

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Action": 123,
  "Content": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Action": 123,
    "Content": "<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({BusinessId: 123, Action: 123, Content: '<string>'})
};

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

An OpenAiChatMessage records a message in an AI-powered chat conversation. Each message tracks the content, the associated customer or operator, and the action type.

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

Enums

eOpenAiChatMessageType — Action values

Value	Name
1	Operator

Request Body

Required Fields

integer

required

ID of the business linked to this record.

integer

required

The action value for this open ai chat message.

string

required

The content value for this open ai chat message.

Optional Fields

integer

ID of the user linked to this record.

integer

ID of the AI channel session linked to this message. Sessions group all messages in a conversation and link it to a specific user and AI channel (e.g. email, chat, WhatsApp).

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/openaichatmessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Action": 0,
    "Content": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Action: 0,
      Content: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Action': 0,
        'Content': ''
    }
)

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 openaichatmessage was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "OpenAiChatMessage was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "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": "Action: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Action"
    }
  ],
  "WasSuccessful": false
}

Update OpenAiChatMessageUpdate an existing OpenAiChatMessage record.

Create OpenAiChatMessage

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Action": 123,
  "Content": "<string>"
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Action": 123,
    "Content": "<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({BusinessId: 123, Action: 123, Content: '<string>'})
};

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400