Skip to main content
POST
Render Visible Questionnaire

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required

Body

application/json
name
string
required
Maximum string length: 300
topics
QuestionnaireTopic · object[]
required
Maximum array length: 200
locale
enum<string>
default:en
Available options:
en,
de
goal
string
default:""
description
string
default:""
success_criteria
string
default:""
interview_context_for_employee
string
default:""
welcome_screen
string
default:""
closing_message
string
default:""
sections
enum<string>[]
Required array length: 1 - 5 elements
Available options:
briefing,
guide,
messages,
settings,
participants

Response

Successful Response

The response is of type file.