Skip to content
SurveyRock Support

Submit NPS response

POST
/nps/{id}/response
curl --request POST \
  --url https://app.surveyrock.com/api/v1/nps/example/response \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "respondentId": "example", "surveyId": "example", "value": 1, "recommendationSubject": "example" }'

Submit an NPS response with validation

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 16 characters <= 16 characters

NPS element ID

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 128 characters

1 to 128 characters, chosen by the caller. Optional on this operation: a retry with the same key and body replays the first response instead of applying the write twice; the same key with a different body is a 409

Request Bodyrequired

Section titled “Request Bodyrequired”

NPS response data

Media typeapplication/json
object
respondentId
required

Respondent ID

string
>= 16 characters <= 16 characters
surveyId
required

Survey ID

string
>= 16 characters <= 16 characters
value
required

NPS score (0-10)

integer
<= 10
recommendationSubject

Optional recommendation subject

string
nullable
Examplegenerated
{
  "respondentId": "example",
  "surveyId": "example",
  "value": 1,
  "recommendationSubject": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

NPS response submitted successfully

Media typeapplication/json
object
success
boolean
data
object
value
integer
type
string
recommendationSubject
string
nullable
submittedAt
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
etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string
Example
{
  "success": true,
  "data": {
    "type": "nps"
  },
  "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
etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

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"
  }
}