Skip to main content
POST
Create an NPS tool definition

Authorizations

Authorization
string
header
required

Company secret API key.

Headers

X-Woku-Idempotency-Key
string

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
name
string
required

Tool name for identification.

Maximum string length: 140
Example:

"Post-Purchase Survey"

npsMessage
string
required

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 - 140
Example:

"our company"

anonymousDisabled
boolean

Require an identified response (email or phone)

onlyOneResponsePerClient
boolean

Accept one response per identified client; anonymous answers never count

folderId
string<ObjectId>

Folder to create the tool in. Must belong to your company. Omit for the root.

audienceType
string

Only who the survey targets (e.g. "a friend or colleague"), NOT the full question.

Maximum string length: 140
Example:

"a friend or colleague"

availableLocales
string[]

Locales the tool is available in (subset of es/en).

Example:
defaultLocale
enum<string>

Default locale used when none is requested.

Available options:
es,
en
Example:

"es"

localizedContent
object[]

Response

NPS tool created