Create FaqArticle

POST

api

content

faqarticles

Create FaqArticle

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

import requests

url = "https://spaces.nexudus.com/api/content/faqarticles"

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

fetch('https://spaces.nexudus.com/api/content/faqarticles', 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 FaqArticle is a frequently asked question and answer published in the members portal, with optional audience restrictions for customers, plans, and teams; location-network visibility is controlled by the viewing location’s FAQ data-visibility setting. Active, customer-eligible articles are also semantically matched to answer questions through the AI chat, WhatsApp, and voice channels. The same matcher can automatically answer Help Desk messages and customer comments when OpenAI Help Desk automation is enabled; matched replies include a link to the source FAQ. FAQ content changes refresh the embeddings used for these AI answers.

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

Request Body

Required Fields

integer

required

ID of the location that owns this FAQ article; the viewing location’s FAQ data-visibility setting controls where it can be displayed across a location network..

string

required

Required question or heading shown for this FAQ article..

integer

required

Numeric position used to order articles within a group; create and update handlers normalize stored positions after changes..

Optional Fields

string

Optional short plain-text or HTML summary of the answer, used with the article content in FAQ search indexing..

string

Optional full answer displayed in the members portal; HTML content is supported and is included in FAQ search indexing..

string

URL of a new file to upload as the image.

boolean

Set to true to remove the current image file.

string

URL of a new file to upload as the large image.

boolean

Set to true to remove the current large image file.

boolean

Whether the article is active and therefore eligible to appear in the members portal, subject to its audience restrictions..

string

Optional group or category name used to organize FAQ articles; portal lists are ordered by group first..

boolean

Whether the article is marked to be shown on the members portal home page..

boolean

Whether the article is restricted to contacts, meaning customers without an active contract; this restriction is cumulative with all other audience restrictions..

boolean

Whether the article is restricted to members, meaning customers with an active contract; this restriction is cumulative with all other audience restrictions..

integer[]

List of plan IDs whose active members may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

integer[]

List of customer IDs who may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

integer[]

List of team IDs whose customers may view this article; an empty list does not restrict access, and this restriction is cumulative with the other audience restrictions..

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/faqarticles',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Title': '',
        'DisplayOrder': 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 faqarticle was created successfully.

array

null on success.

Example Response

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

Create FaqArticle

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

import requests

url = "https://spaces.nexudus.com/api/content/faqarticles"

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

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