Skip to main content
POST
Create a CES 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 Effort"

question
string
required

Public effort question shown to respondents.

Required string length: 3 - 140
Example:

"How easy was it to complete your purchase?"

action
string

Static variable filling 'how easy was it to [action]?'.

Maximum string length: 140
Example:

"complete your purchase"

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

CES tool created