Update a form

PUT

https://www.rapidoform.com/be/api/survey/update/:_id

All requests require X-EMAIL and X-API-KEY. See authentication and errors. JSON request bodies also require Content-Type: application/json. All IDs in examples are synthetic; replace them with your own values.

Parameters

NameType / locationDescription
_idpath numberRequired numeric form ID.
SurveyNamebody stringOptional form name. Capitalization matters; surveyName is only used by create.
statusbody stringOptional: Draft, Collecting, Completed or Stopped.
themeIdbody stringOptional theme ObjectId.

Send only fields to change. Setting status to Collecting validates question configuration. Free plans cannot publish forms containing Payment Question or FileUpload Question. A plan record is required. Ownership/workspace IDs, timestamps, update operators and dotted keys are not editable through this endpoint.

Example request

curl --request PUT 'https://www.rapidoform.com/be/api/survey/update/12345' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"SurveyName":"Updated feedback"}'

JSON request body

{
  "SurveyName": "Updated feedback"
}

Response

Examples show selected fields, not every stored property. Empty arrays are valid for list/report endpoints.

{
  "Errors": [],
  "Info": [],
  "Data": [
    {
      "result": {
        "_id": 12345,
        "SurveyName": "Updated feedback",
        "status": "Draft"
      }
    }
  ],
  "ErrorCode": "SUCCESS",
  "fieldErrors": {
    "List": []
  }
}

HTTP 200 alone does not indicate success. Check ErrorCode and Errors; see troubleshooting.