Create CommunityMessage

POST

api

community

communitymessages

curl --request POST \
  --url https://spaces.nexudus.com/api/community/communitymessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CommunityThreadId": 123,
  "UserId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/community/communitymessages"

payload = {
    "CommunityThreadId": 123,
    "UserId": 123
}
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({CommunityThreadId: 123, UserId: 123})
};

fetch('https://spaces.nexudus.com/api/community/communitymessages', 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 CommunityMessage is an individual reply posted within a CommunityThread conversation on the Discussion Board. Admins and customers with a customer account can add messages to any conversation to help others or share information. Admins can delete any message; customers can only delete their own.

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

Request Body

Required Fields

integer

required

ID of the conversation this message belongs to.

integer

required

ID of the user account that posted this message.

Optional Fields

integer

ID of the customer profile that posted this message.

string

Body text of the message.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/community/communitymessages" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CommunityThreadId": 0,
    "UserId": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/community/communitymessages',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CommunityThreadId': 0,
        'UserId': 0
    }
)

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

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CommunityMessage 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CommunityMessageUpdate an existing CommunityMessage record.

Create CommunityMessage

curl --request POST \
  --url https://spaces.nexudus.com/api/community/communitymessages \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CommunityThreadId": 123,
  "UserId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/community/communitymessages"

payload = {
    "CommunityThreadId": 123,
    "UserId": 123
}
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({CommunityThreadId: 123, UserId: 123})
};

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

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400