Create a form

POST

https://www.rapidoform.com/be/api/survey/create

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
surveyNamestringRequired. Non-empty form name.

Creates a Draft form, a welcome question at order 0, and form settings. Save Data[0].surveyDetails._id for subsequent calls. Free accounts may create at most 3 forms; account expiry also applies (Admin exceptions exist).

Example request

curl --request POST 'https://www.rapidoform.com/be/api/survey/create' \
  --header "X-EMAIL: $RAPIDOFORM_EMAIL" \
  --header "X-API-KEY: $RAPIDOFORM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"surveyName":"Customer feedback"}'

JSON request body

{
  "surveyName": "Customer feedback"
}

Response

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

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

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