Overview

Create a survey, send its link to the customer, and read the score back.

Two halves, and they authenticate differently:

The response endpoints are public on purpose: they are what your survey page calls from the customer's device, where an API key must never be present. The token is the credential, and it authorises exactly one survey.

Two scales are supported: csat_5 (satisfaction, 1–5) and nps_10 (recommendation, 0–10).

Management endpoints

Authorization: Bearer cm_your_api_key

The survey object

{
  "id": "aa11…",
  "tenant_id": "a0b1…",
  "conversation_id": "c0ff…",
  "ticket_id": "e5d4…",
  "contact_id": "4411…",
  "channel": "whatsapp",
  "token": "0Yb3k…",
  "question": "How satisfied were you with this conversation?",
  "scale": "csat_5",
  "sent_at": null,
  "expires_at": "2026-08-24T00:00:00Z",
  "created_at": "2026-08-17T07:00:00Z",
  "updated_at": "2026-08-17T07:00:00Z"
}

token is minted server-side — you cannot supply or choose it. Treat it as a secret: anyone holding it can answer that survey once.

POST /api/v1/csat/surveys

curl -X POST https://api.callmissed.com/api/v1/csat/surveys \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "whatsapp",
    "scale": "nps_10",
    "conversation_id": "c0ffee00-1111-2222-3333-444455556666",
    "expires_at": "2026-08-24T00:00:00Z"
  }'

Returns 201. Build the customer's link from the returned token — point it at your own survey page, which then calls the public endpoints below.

GET /api/v1/csat/surveys

Newest first.

GET /api/v1/csat/stats

{
  "days": 30,
  "surveys_sent": 1840,
  "responses": 611,
  "response_rate": 0.3321,
  "average_rating": 4.31,
  "promoters": 302,
  "passives": 118,
  "detractors": 61,
  "nps": 49.75
}

GET / DELETE /api/v1/csat/surveys/{survey_id}

GET returns one survey. DELETE returns 204 and removes its response along with it. 404 Survey not found.

POST /api/v1/csat/surveys/{survey_id}/sent

Creating a survey does not deliver it: you send the link on your own channel, then call this to record when it went out. Scope: csat:write. Returns the survey with sent_at set. Idempotent — calling it again keeps the first sent_at. 404 Survey not found.

Public response endpoints

No Authorization header. No scope. These are the two calls your survey page makes from the customer's browser or app.

The token is validated globally: an unknown, deleted or malformed token returns the same 404 Survey not found, so the endpoints cannot be used to discover which tokens exist.

Both endpoints are rate limited per client. Handle 429 by asking the customer to retry shortly.

GET /api/v1/csat/r/{token}

Fetch what to render.

curl https://api.callmissed.com/api/v1/csat/r/0Yb3k…

{
  "question": "How likely are you to recommend us to a friend or colleague?",
  "scale": "nps_10",
  "answered": false,
  "expired": false
}

The projection is deliberately minimal — no tenant, contact, conversation or ticket id is exposed to the customer's device.

POST /api/v1/csat/r/{token}

Submit the answer.

curl -X POST https://api.callmissed.com/api/v1/csat/r/0Yb3k… \
  -H "Content-Type: application/json" \
  -d '{ "rating": 9, "comment": "Fast and clear, thanks." }'

{ "status": "recorded" }

The acknowledgement is contentless by design — a submitter learns nothing about your tenant, the survey or your score distribution.

One answer per survey, enforced by a uniqueness constraint rather than a convention. A second submit, including a double-tap race, returns 409 and never a 500.

Checks run in that order, so an expired survey reports 410 rather than leaking whether it was already answered.

Errors on the management half

Nothing on this page consumes credits.