> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Survey

> Update an existing Survey record.

Updates an existing Survey record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  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.
</Note>

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the Survey record to update.
</ParamField>

<ParamField body="BusinessId" type="integer" required>
  Business Id.
</ParamField>

<ParamField body="Name" type="string" required>
  Name.
</ParamField>

<ParamField body="Description" type="string" required>
  Description.
</ParamField>

<ParamField body="NextDeliveryDate" type="string" required>
  Next Delivery Date.
</ParamField>

<ParamField body="DeliveryRate" type="integer" required>
  Delivery Rate.
</ParamField>

<ParamField body="DeliveryFrequency" type="integer" required>
  Delivery Frequency.
</ParamField>

<ParamField body="DeliveryRateMaximum" type="integer" required>
  Delivery Rate Maximum.
</ParamField>

<ParamField body="DeliveryFrequencyMaximum" type="integer" required>
  Delivery Frequency Maximum.
</ParamField>

### Optional Fields

<ParamField body="Active" type="boolean">
  Active.
</ParamField>

<ParamField body="StartDate" type="string">
  Start Date.
</ParamField>

<ParamField body="OnlyForContacts" type="boolean">
  Only For Contacts.
</ParamField>

<ParamField body="OnlyForMembers" type="boolean">
  Only For Members.
</ParamField>

<ParamField body="Tariffs" type="integer[]">
  Tariffs.
</ParamField>

<ParamField body="AddedTariffs" type="integer[]">
  Added Tariffs.
</ParamField>

<ParamField body="RemovedTariffs" type="integer[]">
  Removed Tariffs.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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,
      "DeliveryFrequency": 0,
      "DeliveryRateMaximum": 0,
      "DeliveryFrequencyMaximum": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/surveys',
    {
      method: 'PUT',
      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,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      '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,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the survey was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```