Skip to main content
POST
/
v1
/
ces
Capture a CES score
curl --request POST \
  --url https://clientapi.woku.app/v1/ces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "score": 4,
  "cesToolId": "507f1f77bcf86cd799439011",
  "responseChannel": "<string>",
  "clientEmail": "customer@example.com",
  "anonymous": false,
  "dispatchToken": "<string>"
}
'
{
  "cesId": "507f1f77bcf86cd799439abc",
  "ces": {
    "_id": "<string>",
    "score": 3,
    "anonymous": true,
    "cesToolId": "<string>",
    "clientId": "<string>",
    "responseChannel": "<string>",
    "description": "<string>",
    "transcription": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

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

CES effort score on a 1-5 scale.

Required range: 1 <= x <= 5
Example:

4

​
cesToolId
string
required

CES tool id. Always required: CES tools are always custom.

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

"507f1f77bcf86cd799439011"

​
responseChannel
string

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

Maximum string length: 48
​
clientEmail
string<email>

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

Example:

"customer@example.com"

​
anonymous
boolean
default:false

When true, no respondent email is stored.

​
dispatchToken
string

Opaque invitation dispatch token echoed from the link (?dtoken=). Consumed to mark the outbound invitation responded; never persisted.

Maximum string length: 64

Response

CES response created

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

"507f1f77bcf86cd799439abc"

​
ces
object

The created CES response (curated shape).