Skip to main content
POST
/
v1
/
nps
Capture an NPS score
curl --request POST \
  --url https://clientapi.woku.app/v1/nps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "score": 9,
  "responseChannel": "<string>",
  "npsToolId": "507f1f77bcf86cd799439011",
  "clientEmail": "customer@example.com",
  "anonymous": false
}
'
import requests

url = "https://clientapi.woku.app/v1/nps"

payload = {
"score": 9,
"responseChannel": "<string>",
"npsToolId": "507f1f77bcf86cd799439011",
"clientEmail": "customer@example.com",
"anonymous": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
score: 9,
responseChannel: '<string>',
npsToolId: '507f1f77bcf86cd799439011',
clientEmail: 'customer@example.com',
anonymous: false
})
};

fetch('https://clientapi.woku.app/v1/nps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://clientapi.woku.app/v1/nps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'score' => 9,
'responseChannel' => '<string>',
'npsToolId' => '507f1f77bcf86cd799439011',
'clientEmail' => 'customer@example.com',
'anonymous' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://clientapi.woku.app/v1/nps"

payload := strings.NewReader("{\n \"score\": 9,\n \"responseChannel\": \"<string>\",\n \"npsToolId\": \"507f1f77bcf86cd799439011\",\n \"clientEmail\": \"customer@example.com\",\n \"anonymous\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://clientapi.woku.app/v1/nps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"score\": 9,\n \"responseChannel\": \"<string>\",\n \"npsToolId\": \"507f1f77bcf86cd799439011\",\n \"clientEmail\": \"customer@example.com\",\n \"anonymous\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://clientapi.woku.app/v1/nps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"score\": 9,\n \"responseChannel\": \"<string>\",\n \"npsToolId\": \"507f1f77bcf86cd799439011\",\n \"clientEmail\": \"customer@example.com\",\n \"anonymous\": false\n}"

response = http.request(request)
puts response.read_body
{
  "npsId": "507f1f77bcf86cd799439abc",
  "nps": {
    "_id": "<string>",
    "companyId": "<string>",
    "score": 9,
    "npsToolId": "<string>",
    "clientId": "<string>",
    "anonymous": true,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}
{
"statusCode": 400,
"message": "<string>",
"error": "Bad Request"
}
{
"statusCode": 403,
"message": "Authentication required",
"error": "Forbidden"
}

Authorizations

Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Body

application/json
score
integer
required

NPS score. 0–6 detractor, 7–8 passive, 9–10 promoter.

Required range: 0 <= x <= 10
Example:

9

responseChannel
string

Optional inbound response channel. Defaults to 'api'; a value provided here REPLACES it (user-defined channel).

Maximum string length: 48
npsToolId
string

Optional NPS tool id. With it the score is attached to that tool; without it the score is company-level.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439011"

clientEmail
string<email>

Respondent email. Omit (or set anonymous) for an anonymous score.

Example:

"customer@example.com"

anonymous
boolean
default:false

When true, no respondent email is stored.

Response

NPS score created

npsId
string
Pattern: ^[0-9a-fA-F]{24}$
Example:

"507f1f77bcf86cd799439abc"

nps
object

The created NPS document.