> ## Documentation Index > Fetch the complete documentation index at: https://woku.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # Capture an NPS score > Submits an NPS score (0–10) for the caller company. Provide `npsToolId` to attach the score to a specific NPS tool; omit it for a company-level score. Optionally include the respondent email, or mark the submission anonymous. The detractor (0–6) / passive (7–8) / promoter (9–10) category is derived from the score by Woku. ## OpenAPI ````yaml /openapi-v1.json post /v1/nps openapi: 3.0.3 info: title: Woku Client API v1 description: >- Public Woku Client API. Switch the version selector at the top to view the v0 reference. This spec covers: - **Wokus** — create wokus, fetch review data, submit text/voice reviews, share by email. - **Companies** — `GET /companies/me` returns the caller company. - **Reports** — company-wide and per-tool NPS reports. - **External Trackers** — tag your Wokus with identifiers from third-party systems (CRM transaction id, ERP order id, etc.) and look them up later. ## Authentication All endpoints require a Bearer token in the `Authorization` header. Obtain your company API key from the Woku dashboard. ``` Authorization: Bearer your_api_key_here ``` ## Base URL Production: `https://clientapi.woku.app` ## Model (External Trackers) - **Tracker definition** (`ExternalTracker`): a per-company catalog entry like `{ name: 'trr', system: 'crm interno', description: '...' }`. Defined by an admin in the Woku dashboard. - **Tracker value** (`WokuExternalTrackerValue`): a string value bound to a (Woku, Tracker) pair. Multiple Wokus may share the same value. version: 1.0.0 contact: name: Woku Support url: https://woku.app email: team@woku.app servers: - url: https://clientapi.woku.app description: Production server security: [] tags: - name: Wokus description: >- Create wokus, fetch review data, submit text and voice reviews, share review links by email. - name: Companies description: Caller-company endpoint. - name: Reports description: NPS reports for the caller company and individual NPS tools. - name: NPS description: >- Capture NPS scores (company-level or per NPS tool) and fetch NPS tool definitions. - name: CSAT description: >- Capture CSAT (1-5 satisfaction) scores company-level or per CSAT tool, fetch tool definitions and responses, and submit text and voice feedback. - name: CES description: >- Capture CES (effort) scores company-level or per CES tool, fetch tool definitions and responses, and submit text and voice feedback. - name: External Trackers description: >- Tag Wokus with identifiers from external systems and look them up by name + value. - name: Quarantines description: >- Check whether a respondent is currently quarantined before prompting for feedback. - name: Invitations description: >- Survey distribution: send NPS surveys, forms and woku review invitations by email or WhatsApp. - name: Forms description: Fetch form definitions and submit responses from your own UI. - name: Flows description: Render flow journeys (ordered wokus with an optional NPS) in your own app. - name: Captures description: Mobile SDK capture ingestion paths: /v1/nps: post: tags: - NPS summary: Capture an NPS score description: >- Submits an NPS score (0–10) for the caller company. Provide `npsToolId` to attach the score to a specific NPS tool; omit it for a company-level score. Optionally include the respondent email, or mark the submission anonymous. The detractor (0–6) / passive (7–8) / promoter (9–10) category is derived from the score by Woku. operationId: v1CreateNps requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/V1CreateNpsRequest' responses: '201': description: NPS score created content: application/json: schema: $ref: '#/components/schemas/V1CreateNpsResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationError' '403': description: Invalid or missing API key, or tool belongs to another company content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' security: - BearerAuth: [] - PublishableKey: [] components: schemas: V1CreateNpsRequest: type: object required: - score properties: responseChannel: type: string maxLength: 48 description: >- Optional inbound response channel. Defaults to 'api'; a value provided here REPLACES it (user-defined channel). score: type: integer minimum: 0 maximum: 10 description: NPS score. 0–6 detractor, 7–8 passive, 9–10 promoter. example: 9 npsToolId: type: string pattern: ^[0-9a-fA-F]{24}$ description: >- Optional NPS tool id. With it the score is attached to that tool; without it the score is company-level. example: 507f1f77bcf86cd799439011 clientEmail: type: string format: email description: Respondent email. Omit (or set anonymous) for an anonymous score. example: customer@example.com anonymous: type: boolean description: When true, no respondent email is stored. default: false V1CreateNpsResponse: type: object properties: npsId: type: string pattern: ^[0-9a-fA-F]{24}$ example: 507f1f77bcf86cd799439abc nps: type: object description: The created NPS document. properties: _id: type: string pattern: ^[0-9a-fA-F]{24}$ companyId: type: string pattern: ^[0-9a-fA-F]{24}$ score: type: integer minimum: 0 maximum: 10 example: 9 npsToolId: type: string pattern: ^[0-9a-fA-F]{24}$ description: Present only for tool-specific scores. clientId: type: string pattern: ^[0-9a-fA-F]{24}$ description: Present when the respondent was identified. anonymous: type: boolean createdAt: type: string format: date-time ValidationError: type: object properties: statusCode: type: integer example: 400 message: oneOf: - type: string - type: array items: type: string error: type: string example: Bad Request ForbiddenError: type: object properties: statusCode: type: integer example: 403 message: type: string example: Authentication required error: type: string example: Forbidden securitySchemes: BearerAuth: type: http scheme: bearer description: >- Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints. PublishableKey: type: apiKey in: header name: x-woku-key description: >- Publishable capture key (pk_…), safe to embed in the public web widget. Accepted only on capture endpoints; scoped to capture (cannot create wokus, share, or read reports). ````