Create Survey

POST

api

content

surveys

Create Survey

curl --request POST \
  --url https://spaces.nexudus.com/api/content/surveys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "NextDeliveryDate": "<string>",
  "DeliveryRate": 123,
  "DeliveryFrequency": 123,
  "DeliveryRateMaximum": 123,
  "DeliveryFrequencyMaximum": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "NextDeliveryDate": "<string>",
    "DeliveryRate": 123,
    "DeliveryFrequency": 123,
    "DeliveryRateMaximum": 123,
    "DeliveryFrequencyMaximum": 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,
    Name: '<string>',
    Description: '<string>',
    NextDeliveryDate: '<string>',
    DeliveryRate: 123,
    DeliveryFrequency: 123,
    DeliveryRateMaximum: 123,
    DeliveryFrequencyMaximum: 123
  })
};

fetch('https://spaces.nexudus.com/api/content/surveys', 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 Survey defines a questionnaire that can be delivered to customers on a schedule or triggered by specific events. Surveys support configurable delivery frequency and can target specific customer segments.

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

Enums

eSurveyDeliveryFrequency — DeliveryFrequency values

Value	Name
1	Weeks
2	Months
3	Years

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

The name value for this survey.

string

required

Free-text description of this survey.

string

required

Date/time value for next delivery date.

integer

required

The delivery rate value for this survey.

integer

required

The delivery frequency value for this survey.

integer

required

The delivery rate maximum value for this survey.

integer

required

The delivery frequency maximum value for this survey.

Optional Fields

boolean

Whether this survey is currently active.

string

Date/time value for start date.

boolean

Whether only for contacts is enabled.

boolean

Whether only for members is enabled.

integer[]

List of tariffs linked to this record.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/surveys" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Description": "",
    "NextDeliveryDate": "2025-01-15T10:30:00Z",
    "DeliveryRate": 0,
    "DeliveryFrequency": 0,
    "DeliveryRateMaximum": 0,
    "DeliveryFrequencyMaximum": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveys',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Description: '',
      NextDeliveryDate: '2025-01-15T10:30:00Z',
      DeliveryRate: 0,
      DeliveryFrequency: 0,
      DeliveryRateMaximum: 0,
      DeliveryFrequencyMaximum: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/surveys',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Description': '',
        'NextDeliveryDate': '2025-01-15T10:30:00Z',
        'DeliveryRate': 0,
        'DeliveryFrequency': 0,
        'DeliveryRateMaximum': 0,
        'DeliveryFrequencyMaximum': 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 survey was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Survey 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 SurveyUpdate an existing Survey record.

Create Survey

curl --request POST \
  --url https://spaces.nexudus.com/api/content/surveys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "NextDeliveryDate": "<string>",
  "DeliveryRate": 123,
  "DeliveryFrequency": 123,
  "DeliveryRateMaximum": 123,
  "DeliveryFrequencyMaximum": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "NextDeliveryDate": "<string>",
    "DeliveryRate": 123,
    "DeliveryFrequency": 123,
    "DeliveryRateMaximum": 123,
    "DeliveryFrequencyMaximum": 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,
    Name: '<string>',
    Description: '<string>',
    NextDeliveryDate: '<string>',
    DeliveryRate: 123,
    DeliveryFrequency: 123,
    DeliveryRateMaximum: 123,
    DeliveryFrequencyMaximum: 123
  })
};

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