Skip to main content
PUT
/
api
/
content
/
surveys
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing Survey record. You must include the Id of the record to update along with all required fields.

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-Edit role.

Request Body

Required Fields

Id
integer
required
The Id of the Survey record to update.
BusinessId
integer
required
Business Id.
Name
string
required
Name.
Description
string
required
Description.
NextDeliveryDate
string
required
Next Delivery Date.
DeliveryRate
integer
required
Delivery Rate.
DeliveryRateMaximum
integer
required
Delivery Rate Maximum.

Optional Fields

Active
boolean
Active.
DeliveryFrequency
integer
Delivery Frequency. See eSurveyDeliveryFrequency enum above.
DeliveryFrequencyMaximum
integer
Delivery Frequency Maximum. See eSurveyDeliveryFrequency enum above.
StartDate
string
Start Date.
OnlyForContacts
boolean
Only For Contacts.
OnlyForMembers
boolean
Only For Members.
Tariffs
integer[]
Tariffs.
AddedTariffs
integer[]
Added Tariffs.
RemovedTariffs
integer[]
Removed Tariffs.

Code Examples

curl -X PUT \
  "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,
    "DeliveryRateMaximum": 0,
    "Id": 87654321
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the update.
Value
object
Contains the Id of the updated record.
WasSuccessful
boolean
true if the survey was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Survey was successfully updated.",
  "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

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
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
}