Skip to main content
PATCH
Update Clarity Process

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

id
string<uuid>
required

Clarity process id

Body

application/json
name
string

New process name

Required string length: 1 - 255
status
enum<string>

Mark a review-stage process complete, or reopen a completed process for review

Available options:
complete,
review
customPrompt
string | null

Process-specific guidance, or null to clear it

Maximum string length: 5000
visibility
enum<string>

Process visibility within the team

Available options:
team,
restricted
independentInterviews
boolean

Run each interview independently: no briefing from earlier interviews and a neutral opener

mapLanguage
enum<string> | null

Language Duvo writes this process's map in, or null to use the team's map language

Available options:
cs,
de,
de-CH,
en,
en-GB,
es,
es-MX,
fr,
hu,
pl,
pt,
pt-BR,
sk,
sl,
th,
uk,
ar-EG,
ar-SA,
da-DK,
de-AT,
el-GR,
en-AU,
en-GB-scotland,
en-IE,
en-IN,
en-NG,
en-ZA,
es-AR,
fi-FI,
fr-BE,
fr-CA,
gsw-CH,
he-IL,
hi-IN,
hi-Latn-IN,
id-ID,
it-IT,
ja-JP,
ko-KR,
nb-NO,
nl-BE,
nl-NL,
ro-RO,
sv-SE,
tr-TR,
vi-VN,
yue-HK,
zh-Hans-CN,
zh-Hant-TW,
af-ZA,
ak-GH,
sq-AL,
am-ET,
hy-AM,
as-IN,
az-AZ,
eu-ES,
be-BY,
bn-BD,
bs-BA,
bg-BG,
my-MM,
ca-ES,
ceb-PH,
hr-HR,
et-EE,
fo-FO,
fil-PH,
gl-ES,
ka-GE,
gu-IN,
ha-NG,
is-IS,
ga-IE,
kn-IN,
kk-KZ,
km-KH,
rw-RW,
ku-TR,
ky-KG,
lo-LA,
lv-LV,
lt-LT,
mk-MK,
ms-MY,
ml-IN,
mt-MT,
mi-NZ,
mr-IN,
mn-MN,
ne-NP,
or-IN,
om-ET,
ps-AF,
fa-IR,
pa-IN,
qu-PE,
rm-CH,
ru-RU,
sr-RS,
sd-PK,
si-LK,
so-SO,
st-ZA,
sw-TZ,
tg-TJ,
ta-IN,
te-IN,
tn-ZA,
tk-TM,
ur-PK,
uz-UZ,
cy-GB,
fy-NL,
wo-SN,
yo-NG,
zu-ZA,
bn-IN,
ur-IN,
fr-CH,
it-CH,
de-BE,
sw-KE,
sw-UG,
ms-SG,
zh-Hans-SG,
ta-SG,
ta-LK,
yue-CN,
ar-IL,
ar-MA,
fr-MA,
sv-FI,
es-US,
ru-BY,
ru-KZ,
fa-AF,
ar-DZ,
fr-DZ,
ar-TN,
fr-TN,
ar-LY,
ar-SD,
ar-IQ,
ku-IQ,
ar-SY,
ar-JO,
ar-AE,
ar-QA,
ar-KW,
ar-OM,
ar-YE,
ar-LB,
fr-LB,
pt-AO,
pt-MZ,
es-CO,
es-PE,
es-CL,
es-VE,
es-EC,
es-BO,
qu-BO,
es-PY,
es-UY,
es-CU,
es-GT,
es-HN,
es-NI,
es-CR,
es-PA,
es-DO,
es-SV,
sr-ME,
fr-CD,
fr-CI,
fr-SN,
fr-ML,
fr-CM,
da-GL,
tn-BW,
af-NA,
el-CY,
tr-CY,
fr-LU,
de-LU,
en-CA,
en-NZ,
en-SG,
en-PH,
en-KE,
en-GH,
en-PK

Response

Default Response

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
draft,
collecting,
generating,
generating-current-process,
generating-transformation-proposal,
review,
complete,
generation_failed
visibility
enum<string>
required
Available options:
team,
restricted
customPrompt
string | null
required
independentInterviews
boolean
required
mapLanguage
string | null
required
updatedAt
string
required