Create a text review for a Woku
curl --request POST \
--url https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qualification": 5,
"description": "Excellent service! The staff was very helpful.",
"responseChannel": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": 123,
"anonymous": false
}
'import requests
url = "https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes"
payload = {
"qualification": 5,
"description": "Excellent service! The staff was very helpful.",
"responseChannel": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": 123,
"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({
qualification: 5,
description: 'Excellent service! The staff was very helpful.',
responseChannel: '<string>',
clientEmail: 'jsmith@example.com',
clientPhone: 123,
anonymous: false
})
};
fetch('https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes', 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/wokus/{wokuId}/textnotes",
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([
'qualification' => 5,
'description' => 'Excellent service! The staff was very helpful.',
'responseChannel' => '<string>',
'clientEmail' => 'jsmith@example.com',
'clientPhone' => 123,
'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/wokus/{wokuId}/textnotes"
payload := strings.NewReader("{\n \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\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/wokus/{wokuId}/textnotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\n \"anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes")
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 \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\n \"anonymous\": false\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": "<string>",
"error": "Bad Request"
}{
"statusCode": 403,
"message": "Authentication required",
"error": "Forbidden"
}{
"statusCode": 404,
"message": "External tracker not found",
"error": "Not Found"
}Wokus
Create a text review for a Woku
Submits a text review (star rating + text feedback) for a Woku.
POST
/
v1
/
wokus
/
{wokuId}
/
textnotes
Create a text review for a Woku
curl --request POST \
--url https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"qualification": 5,
"description": "Excellent service! The staff was very helpful.",
"responseChannel": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": 123,
"anonymous": false
}
'import requests
url = "https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes"
payload = {
"qualification": 5,
"description": "Excellent service! The staff was very helpful.",
"responseChannel": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": 123,
"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({
qualification: 5,
description: 'Excellent service! The staff was very helpful.',
responseChannel: '<string>',
clientEmail: 'jsmith@example.com',
clientPhone: 123,
anonymous: false
})
};
fetch('https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes', 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/wokus/{wokuId}/textnotes",
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([
'qualification' => 5,
'description' => 'Excellent service! The staff was very helpful.',
'responseChannel' => '<string>',
'clientEmail' => 'jsmith@example.com',
'clientPhone' => 123,
'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/wokus/{wokuId}/textnotes"
payload := strings.NewReader("{\n \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\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/wokus/{wokuId}/textnotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\n \"anonymous\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://clientapi.woku.app/v1/wokus/{wokuId}/textnotes")
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 \"qualification\": 5,\n \"description\": \"Excellent service! The staff was very helpful.\",\n \"responseChannel\": \"<string>\",\n \"clientEmail\": \"jsmith@example.com\",\n \"clientPhone\": 123,\n \"anonymous\": false\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 400,
"message": "<string>",
"error": "Bad Request"
}{
"statusCode": 403,
"message": "Authentication required",
"error": "Forbidden"
}{
"statusCode": 404,
"message": "External tracker not found",
"error": "Not Found"
}Authorizations
BearerAuthPublishableKey
Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.
Path Parameters
MongoDB ObjectId of the Woku.
Pattern:
^[0-9a-fA-F]{24}$Body
application/json
Available options:
1, 2, 3, 4, 5 Example:
5
Maximum string length:
3000Example:
"Excellent service! The staff was very helpful."
Optional inbound response channel. Defaults to 'api'; a value provided here REPLACES it (user-defined channel).
Maximum string length:
48Reviewer phone number.
Response
Textnote created
⌘I