Create an NPS tool definition
curl --request POST \
--url https://clientapi.woku.app/v1/nps-tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Post-Purchase Survey",
"npsMessage": "our company",
"audienceType": "a friend or colleague",
"availableLocales": [
"es",
"en"
],
"defaultLocale": "es",
"localizedContent": [
{
"locale": "en",
"npsMessage": "our company",
"audienceType": "a friend or colleague"
}
]
}
'import requests
url = "https://clientapi.woku.app/v1/nps-tools"
payload = {
"name": "Post-Purchase Survey",
"npsMessage": "our company",
"audienceType": "a friend or colleague",
"availableLocales": ["es", "en"],
"defaultLocale": "es",
"localizedContent": [
{
"locale": "en",
"npsMessage": "our company",
"audienceType": "a friend or colleague"
}
]
}
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({
name: 'Post-Purchase Survey',
npsMessage: 'our company',
audienceType: 'a friend or colleague',
availableLocales: ['es', 'en'],
defaultLocale: 'es',
localizedContent: [
{locale: 'en', npsMessage: 'our company', audienceType: 'a friend or colleague'}
]
})
};
fetch('https://clientapi.woku.app/v1/nps-tools', 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-tools",
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([
'name' => 'Post-Purchase Survey',
'npsMessage' => 'our company',
'audienceType' => 'a friend or colleague',
'availableLocales' => [
'es',
'en'
],
'defaultLocale' => 'es',
'localizedContent' => [
[
'locale' => 'en',
'npsMessage' => 'our company',
'audienceType' => 'a friend or colleague'
]
]
]),
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-tools"
payload := strings.NewReader("{\n \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\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-tools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/nps-tools")
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 \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\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-tools
Create an NPS tool definition
POST
/
v1
/
nps-tools
Create an NPS tool definition
curl --request POST \
--url https://clientapi.woku.app/v1/nps-tools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Post-Purchase Survey",
"npsMessage": "our company",
"audienceType": "a friend or colleague",
"availableLocales": [
"es",
"en"
],
"defaultLocale": "es",
"localizedContent": [
{
"locale": "en",
"npsMessage": "our company",
"audienceType": "a friend or colleague"
}
]
}
'import requests
url = "https://clientapi.woku.app/v1/nps-tools"
payload = {
"name": "Post-Purchase Survey",
"npsMessage": "our company",
"audienceType": "a friend or colleague",
"availableLocales": ["es", "en"],
"defaultLocale": "es",
"localizedContent": [
{
"locale": "en",
"npsMessage": "our company",
"audienceType": "a friend or colleague"
}
]
}
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({
name: 'Post-Purchase Survey',
npsMessage: 'our company',
audienceType: 'a friend or colleague',
availableLocales: ['es', 'en'],
defaultLocale: 'es',
localizedContent: [
{locale: 'en', npsMessage: 'our company', audienceType: 'a friend or colleague'}
]
})
};
fetch('https://clientapi.woku.app/v1/nps-tools', 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-tools",
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([
'name' => 'Post-Purchase Survey',
'npsMessage' => 'our company',
'audienceType' => 'a friend or colleague',
'availableLocales' => [
'es',
'en'
],
'defaultLocale' => 'es',
'localizedContent' => [
[
'locale' => 'en',
'npsMessage' => 'our company',
'audienceType' => 'a friend or colleague'
]
]
]),
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-tools"
payload := strings.NewReader("{\n \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\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-tools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/nps-tools")
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 \"name\": \"Post-Purchase Survey\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\",\n \"availableLocales\": [\n \"es\",\n \"en\"\n ],\n \"defaultLocale\": \"es\",\n \"localizedContent\": [\n {\n \"locale\": \"en\",\n \"npsMessage\": \"our company\",\n \"audienceType\": \"a friend or colleague\"\n }\n ]\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.
Headers
Client-generated key to make the create safe to retry. A retry with the same key returns the original result instead of creating again.
Body
application/json
Tool name for identification.
Maximum string length:
140Example:
"Post-Purchase Survey"
Only the company, product or service recommended (e.g. "our company"), NOT the full question. The public question is composed as "On a scale of 0 to 10, how likely are you to recommend {npsMessage} to {audienceType}?".
Required string length:
3 - 140Example:
"our company"
Only who the survey targets (e.g. "a friend or colleague"), NOT the full question.
Maximum string length:
140Example:
"a friend or colleague"
Locales the tool is available in (subset of es/en).
Example:
["es", "en"]
Default locale used when none is requested.
Available options:
es, en Example:
"es"
Show child attributes
Show child attributes
Response
NPS tool created