Create CommunityThread

POST

api

community

communitythreads

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

import requests

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

payload = {
    "BusinessId": 123,
    "UserId": 123,
    "Subject": "<string>",
    "Message": "<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, UserId: 123, Subject: '<string>', Message: '<string>'})
};

fetch('https://spaces.nexudus.com/api/community/communitythreads', 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 Discussion Board conversation is an opening message with replies that customers can follow; a community group or private guest list controls who can access it.

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

Request Body

Required Fields

integer

required

ID of the location this Discussion Board conversation belongs to.

integer

required

ID of the user account that authors this conversation.

string

required

Required title or topic of the Discussion Board conversation.

string

required

Required body text of the opening message in this conversation.

Optional Fields

integer

Optional ID of the community group that controls access to this conversation; its Public, Restricted, or Private access level applies in addition to this thread’s Private setting.

integer

Optional ID of the customer profile displayed as the author; when omitted on creation, Nexudus uses the author’s matching customer profile at the location.

boolean

Whether to notify followers about this new conversation immediately instead of waiting for their scheduled digest.

string

Comma-separated search tags that help customers find this conversation.

boolean

Whether this conversation is visible only to its author and the users in Guests; a private community group also restricts visibility regardless of this setting.

integer[]

List of user IDs allowed to read this thread when Private is true; an assigned community group’s members are added automatically when the thread is created.

boolean

Whether to create a Zoom meeting and attach its invite when this conversation is created.

string

Internal JSON payload containing Zoom meeting details generated and maintained by the Zoom integration.

Code Examples

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

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

const data = await response.json();

import requests

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

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

array

null on success.

Example Response

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

Create CommunityThread

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

import requests

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

payload = {
    "BusinessId": 123,
    "UserId": 123,
    "Subject": "<string>",
    "Message": "<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, UserId: 123, Subject: '<string>', Message: '<string>'})
};

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