Capture an NPS score (company-level or tool-specific)
curl --request POST \
--url https://clientapi.woku.app/v1/nps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"score": 9,
"npsToolId": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"anonymous": true,
"responseChannel": "my-crm",
"dispatchToken": "a1b2c3d4-..."
}
'import requests
url = "https://clientapi.woku.app/v1/nps"
payload = {
"score": 9,
"npsToolId": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"anonymous": True,
"responseChannel": "my-crm",
"dispatchToken": "a1b2c3d4-..."
}
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,
npsToolId: '<string>',
clientEmail: 'jsmith@example.com',
clientPhone: '<string>',
anonymous: true,
responseChannel: 'my-crm',
dispatchToken: 'a1b2c3d4-...'
})
};
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,
'npsToolId' => '<string>',
'clientEmail' => 'jsmith@example.com',
'clientPhone' => '<string>',
'anonymous' => true,
'responseChannel' => 'my-crm',
'dispatchToken' => 'a1b2c3d4-...'
]),
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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": [
"email must be a valid email",
"password must be at least 8 characters"
],
"error": "Bad Request"
}v1 - nps
Capture an NPS score (company-level or tool-specific)
POST
/
v1
/
nps
Capture an NPS score (company-level or tool-specific)
curl --request POST \
--url https://clientapi.woku.app/v1/nps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"score": 9,
"npsToolId": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"anonymous": true,
"responseChannel": "my-crm",
"dispatchToken": "a1b2c3d4-..."
}
'import requests
url = "https://clientapi.woku.app/v1/nps"
payload = {
"score": 9,
"npsToolId": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"anonymous": True,
"responseChannel": "my-crm",
"dispatchToken": "a1b2c3d4-..."
}
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,
npsToolId: '<string>',
clientEmail: 'jsmith@example.com',
clientPhone: '<string>',
anonymous: true,
responseChannel: 'my-crm',
dispatchToken: 'a1b2c3d4-...'
})
};
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,
'npsToolId' => '<string>',
'clientEmail' => 'jsmith@example.com',
'clientPhone' => '<string>',
'anonymous' => true,
'responseChannel' => 'my-crm',
'dispatchToken' => 'a1b2c3d4-...'
]),
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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\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 \"npsToolId\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": \"<string>\",\n \"anonymous\": true,\n \"responseChannel\": \"my-crm\",\n \"dispatchToken\": \"a1b2c3d4-...\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": [
"email must be a valid email",
"password must be at least 8 characters"
],
"error": "Bad Request"
}Authorizations
Company secret API key.
Body
application/json
NPS score 0-10 (0-6 detractor, 7-8 passive, 9-10 promoter)
Required range:
0 <= x <= 10Example:
9
Optional NPS tool id. With it the capture is tool-specific; without it, company-level.
Respondent email. Omit for an anonymous capture.
Respondent phone when email is not supplied.
Whether the submission is anonymous (no client email stored).
Inbound response channel. Defaults to 'api'; a value provided here REPLACES 'api' (user-defined channel). Stored on the NPS.
Maximum string length:
48Example:
"my-crm"
Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.
Maximum string length:
64Example:
"a1b2c3d4-..."
Response
NPS created