Skip to main content
POST
/
v1
/
captures
Capture a woku review or NPS response (mobile SDK)
curl --request POST \
  --url https://clientapi.woku.app/v1/captures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "targetId": "<string>",
  "rating": 3,
  "score": 5,
  "comment": "<string>",
  "respondent": {
    "email": "<string>",
    "phone": "<string>",
    "externalId": "<string>"
  }
}
'
{
  "id": "<string>",
  "remoteId": "<string>",
  "status": "accepted"
}

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.

Headers

​
X-Woku-Idempotency-Key
string

Client-generated submission id for idempotent retries (falls back to payload.id).

Body

Normalized capture from the Woku mobile SDK. The response channel is sealed server-side to 'mobile-sdk' (it is not read from the body).

​
kind
enum<string>
required
Available options:
woku,
nps
​
id
string

Client-generated idempotency id

​
targetId
string

wokuId for a woku capture; optional npsToolId for an NPS capture (company-level when omitted)

​
rating
integer

Woku star rating (kind=woku)

Required range: 1 <= x <= 5
​
score
integer

NPS score (kind=nps)

Required range: 0 <= x <= 10
​
comment
string
Maximum string length: 3000
​
respondent
object

Response

Capture accepted

​
id
string

Echo of the client idempotency id

​
kind
enum<string>
Available options:
woku,
nps
​
remoteId
string

Server id of the created review or NPS

​
status
enum<string>
Available options:
accepted