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 (Survey) is a location-specific questionnaire sent to selected customers on a recurring schedule. It defines delivery timing, customer eligibility, and the questions customers can answer.

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 location that owns this survey; the Admin Tool normally supplies it from the current location context.

string

required

Required name used by administrators to identify this survey.

string

required

Required free-text description explaining the purpose of this survey.

string

required

UTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery.

integer

required

Positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery.

integer

required

Unit used by DeliveryRate and the delivery cap: Weeks, Months, or Years; defaults to Weeks.

integer

required

Maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date.

integer

required

Legacy delivery-cap frequency setting; the delivery-cap calculation uses DeliveryFrequency, so manage the cap with DeliveryRateMaximum and DeliveryFrequency instead.

Optional Fields

boolean

Whether this survey is eligible for scheduled delivery when its next delivery date is due.

string

Optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply.

boolean

Whether delivery is restricted to contacts without an active contract; when enabled with OnlyForMembers, both restrictions apply and no customer can qualify.

boolean

Whether delivery is restricted to members with an active contract; when Tariffs is non-empty, the contract must be on one of those plans.

integer[]

List of plans eligible for member-only delivery; when OnlyForMembers is enabled, an empty list allows every member, otherwise the customer needs an active contract on one of these plans.

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
}

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