Skip to main content
POST
Schedule a report by email

Authorizations

Authorization
string
header
required

Company secret API key.

Body

application/json
scopeType
enum<string>
required
Available options:
folder,
woku,
nps,
csat,
ces
scopeId
string<ObjectId>
required

Folder or tool id

frequency
enum<string>
required

monthly (1st), biweekly (1st and 16th), weekly (Mondays) at 12:00 UTC with the previous complete period, or once

Available options:
monthly,
biweekly,
weekly,
once
recipients
string[]
required

Recipient emails, 1 to 10; they need no woku account

includeCsv
boolean

Folder only: also attach the CSV

locale
enum<string>
default:es
Available options:
es,
en
sendAt
string

once only: when to send it (ISO); absent = now

periodFrom
string

once only: period start (ISO)

periodTo
string

once only: period end (ISO, exclusive)

Response

Scheduled report created