Skip to content
SurveyRock Support

Create new survey

POST
/surveys
curl --request POST \
  --url https://app.surveyrock.com/api/v1/surveys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "language": "en", "type": 1, "settings": {} }'

Create new survey using shared SurveyService. Uses the same service as web SurveyController to ensure zero duplication.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

Survey creation data

Media typeapplication/json
object
name
required

Survey name

string
description

Survey description

string
nullable
language

Survey language code

string
default: en
type

Survey type

integer
default: 1
settings

Survey configuration settings

object

Responses

Section titled “Responses”

200

Section titled “200”

Survey created successfully

Media typeapplication/json
object
success
boolean
data
object
surveyId
string
name
string
createdAt
string format: date-time
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": true,
  "meta": {
    "version": "3.0"
  }
}

400

Section titled “400”

Bad request - invalid data

Media typeapplication/json

Standard error response format

object
success
boolean
error
object
code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string
message

Human-readable error message

string
suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string
retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean
details

Additional, code-specific error details

object
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}

422

Section titled “422”

Validation failed

Media typeapplication/json

Validation error response with field-specific errors

object
success
boolean
error
object
code
string
message
string
suggestion
string
retryable
boolean
details

Field-specific validation errors

object
key
additional properties
Array<string>
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "Validation failed",
    "suggestion": "Fix the fields listed in details and re-submit.",
    "retryable": false
  },
  "meta": {
    "version": "3.0"
  }
}