POST/nps/submit

Submit an NPS response

Submit a Net Promoter Score (0-10) plus an optional verbatim comment. The server atomically writes a Rating, an optional Feedback (when a comment was provided), and an NpsResponse sidecar linking them. Authentication is by `project_key` + origin allow-list, the same pattern as `/feedback/submit` and `/rating/submit`.

Base URLhttps://seggwat.com/api/v1

Parameters

Refererheaderstring (uri-reference)

Optional HTTP Referer header indicating the page URL where the submission originated

Example: https://example.com/dashboard

Request Body

required

NPS submission payload.

application/json

NpsSubmit

Payload for `POST /nps/submit`.

commentstringnullable

Optional free-text follow-up. Empty / whitespace-only values are treated as absent and skip creating a Feedback row.

Example: Great onboarding, minor nits on billing copy.

localestringnullable

Locale the user saw when answering.

Example: en

pathstringnullable

Path on which the response was collected.

Example: /dashboard

project_keystring (uuid)required(uuid)

Project key from the dashboard.

Example: 550e8400-e29b-41d4-a716-446655440000

scoreintegerrequired

0-10 recommendation-likelihood rating.

Example: 9

submitted_bystringnullable

Opaque user identifier from your system (no PII).

Example: user_12345

versionstringnullable

App version the responder saw.

Example: 1.2.3

Responses

Request

POST/nps/submit

curl \
  -X POST \
  "https://seggwat.com/api/v1/nps/submit" \
  -H "Content-Type: application/json" \
  -d '{
  "comment": "Great onboarding, minor nits on billing copy.",
  "locale": "en",
  "path": "/dashboard",
  "project_key": "550e8400-e29b-41d4-a716-446655440000",
  "score": 9,
  "submitted_by": "user_12345",
  "version": "1.2.3"
}'

Response

201application/json

{
  "band": "detractor",
  "feedback_id": "string",
  "nps_response_id": "string",
  "rating_id": "string"
}

Navigation