Skip to main content
POST
/
v1
/
external-trackers
/
{entityType}
/
{id}
curl --request POST \
  --url https://clientapi.woku.app/v1/external-trackers/{entityType}/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "trr",
  "value": "TX-2026-00043"
}
'
{
  "_id": "507f1f77bcf86cd799439015",
  "companyId": "507f1f77bcf86cd799439012",
  "entityType": "nps",
  "entityId": "507f1f77bcf86cd799439abc",
  "trackerId": "507f1f77bcf86cd799439014",
  "value": "TX-2026-00043",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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.

Path Parameters

​
entityType
enum<string>
required

VoC entity type that carries the tracker value. woku is not allowed here; use the dedicated /v1/external-trackers/wokus/{wokuId} routes.

Available options:
nps,
csat,
ces,
form,
flow
​
id
string
required

MongoDB ObjectId of the VoC entity.

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

Body

application/json
​
name
string
required

Name of the company-level tracker definition the value belongs to.

Maximum string length: 60
Example:

"trr"

​
value
string
required

External identifier value (always stored as string).

Maximum string length: 500
Example:

"TX-2026-00043"

Response

Value assigned (created) or updated

Value of a tracker bound to a specific VoC entity (NPS/CSAT/CES tool, Form or Flow). The polymorphic (entityType, entityId) pair generalizes what WokuExternalTrackerValue does for Wokus.

​
_id
string
required
Example:

"507f1f77bcf86cd799439015"

​
companyId
string
required
Example:

"507f1f77bcf86cd799439012"

​
entityType
enum<string>
required

VoC entity type that carries this value.

Available options:
nps,
csat,
ces,
form,
flow
Example:

"nps"

​
entityId
string
required

VoC entity this value belongs to.

Example:

"507f1f77bcf86cd799439abc"

​
trackerId
string
required

Reference to the company-level tracker definition.

Example:

"507f1f77bcf86cd799439014"

​
value
string
required

External identifier (e.g. CRM transaction id).

Maximum string length: 500
Example:

"TX-2026-00043"

​
createdAt
string<date-time>
​
updatedAt
string<date-time>