Create FormPageQuestion

POST

api

content

formpagequestions

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

import requests

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

payload = {
    "FormPageId": 123,
    "Text": "<string>",
    "Description": "<string>",
    "DisplayOrder": 123,
    "QuestionType": 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({
    FormPageId: 123,
    Text: '<string>',
    Description: '<string>',
    DisplayOrder: 123,
    QuestionType: 123
  })
};

fetch('https://spaces.nexudus.com/api/content/formpagequestions', 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 form question (FormPageQuestion) is an ordered question within a location’s customer form. It defines the customer-facing label, explanation, input type, optional choices, and whether the question is shown or required.

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

Enums

eQuestionType — QuestionType values

Value	Name
1	Text
2	Boolean
3	LongText
4	Date
5	Dropdown
6	Binary

Request Body

Required Fields

integer

required

ID of the form that contains this question; the form’s location determines access to the question.

string

required

Required question label shown to customers.

string

required

Required explanatory text shown below the question to customers.

integer

required

Integer position for displaying this question; lower values appear first and the system renumbers questions after create or update.

integer

required

Controls the customer input: Text, Boolean (Yes/No), LongText, Date, Dropdown, or Binary file upload; defaults to Text.

Optional Fields

string

Comma-separated choices for a Dropdown question; leave empty for other question types.

boolean

Whether this question appears in the customer-facing form.

boolean

Whether customers can select more than one choice for a Dropdown question.

boolean

Whether the customer-facing form marks an answer to this question as required.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/formpagequestions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "FormPageId": 0,
    "Text": "",
    "Description": "",
    "DisplayOrder": 0,
    "QuestionType": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/formpagequestions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'FormPageId': 0,
        'Text': '',
        'Description': '',
        'DisplayOrder': 0,
        'QuestionType': 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 formpagequestion was created successfully.

array

null on success.

Example Response

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

Create FormPageQuestion

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

import requests

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

payload = {
    "FormPageId": 123,
    "Text": "<string>",
    "Description": "<string>",
    "DisplayOrder": 123,
    "QuestionType": 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({
    FormPageId: 123,
    Text: '<string>',
    Description: '<string>',
    DisplayOrder: 123,
    QuestionType: 123
  })
};

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