Skip to content
Survey Coder Pro Survey Coder Pro

Create a new project

POST
/v2/projects
 
curl --request POST \
  --url https://api.surveycoder.io/v2/projects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "name": "Q4 NPS Survey", "language": "en", "coding_type": "qualitative", "objective": "example" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
Example 
Q4 NPS Survey
language
string
default: en
coding_type
string
default: qualitative
Allowed values: qualitative entity
objective
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Project created

Media type application/json
object
success
boolean
data
object
id
string format: uuid
name
string
language
string
coding_type
string
status
string
Allowed values: pending in_progress completed
created_at
string format: date-time
questions
Array<object>
object
id
string format: uuid
text
string
status
string
Allowed values: pending codebook_ready coding coded
coding_type
string
response_count
integer
Example 
{
  "success": true,
  "data": {
    "name": "Q4 NPS Survey",
    "language": "en",
    "coding_type": "qualitative",
    "status": "pending",
    "questions": [
      {
        "text": "What did you like most about our service?",
        "status": "pending"
      }
    ]
  }
}

401

Section titled “401 ”

Missing or invalid API key.

Media type application/json

Standard error envelope.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code. See the error reference for the full list.

string
message
required

Human-readable explanation of what went wrong.

string
request_id

Echo of the X-Request-Id header, when provided.

string format: uuid
doc_url

Link to documentation for this specific error code.

string format: uri
Example 
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "x-api-key header is required",
    "doc_url": "https://docs.surveycoder.io/errors/unauthorized"
  }
}