Skip to main content
POST

Authorizations

Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

Idempotency-Key
string | null
X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Body

application/json
target_audience
string
required

Description of the audience to recruit

Minimum string length: 1
target
integer
required

Target number of completed interviews

incident_rate
number
required

Expected audience incidence rate as percentage points (for example, 8.5 means 8.5%).

Required range: 0 <= x <= 100
country_code
enum<string>[] | null

Optional ISO 3166-1 alpha-2 country codes. Omit for no country restriction.

Available options:
AR,
AU,
AT,
BE,
BO,
BR,
CA,
CL,
CN,
CO,
CR,
CZ,
DK,
DO,
EC,
EG,
FI,
FR,
DE,
GR,
HK,
HU,
IN,
ID,
IE,
IT,
JP,
KE,
KR,
LU,
MY,
MX,
NL,
NZ,
NG,
NO,
PK,
PE,
PH,
PL,
PT,
RO,
RU,
SA,
SG,
SK,
ZA,
ES,
SE,
CH,
TW,
TH,
TR,
UG,
AE,
GB,
US,
VN
study_id
string | null

Optional existing study ID

Response

Successful Response

id
string
required
target_audience
string
required
target
integer
required
incident_rate
number
required
created_at
string<date-time>
required
status
enum<string>
required
Available options:
received,
responded,
cancelled
country_code
string[] | null
study_id
string | null
estimated_total_cost_per_interview_usd
number | null
estimated_total_cost_usd
number | null
estimated_timeline_hours
number | null
responded_at
string<date-time> | null
cancelled_at
string<date-time> | null
expected_response_by
string<date-time> | null

Review deadline when one has been committed; null means no deadline has been set.