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 represents a frequently asked question and its answer, displayed on the members portal to help customers find information without contacting support.

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 business linked to this record.

string

required

The title value for this faq article.

integer

required

The display order value for this faq article.

Optional Fields

string

The summary text value for this faq article.

string

The full text value for this faq article.

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 this faq article is currently active.

string

The group name value for this faq article.

boolean

Whether show in home page is enabled.

boolean

Whether only for contacts is enabled.

boolean

Whether only for members is enabled.

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
}

Update FaqArticleUpdate an existing FaqArticle record.

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