Skip to content
/
Participant

Participant

Request

Creates a new participant.

Note — Retake: To allow a participant to retake an unsuccessfully completed questionnaire, provide the existing participant's participant_uuid. This is only supported for participants who did not successfully complete the questionnaire.

Security
authorization
Bodyapplication/jsonrequired
One of:
project_uuidstringrequired

UUID of the project/questionnaire

Example:"fd9690b0-9050-4acd-ad74-7f906c07fe93"
phone_number1string

Primary phone number (optional)

Example:"+916263877039"
phone_number2string

Secondary phone number (optional)

Example:""
interview_ref_numstringrequired

Interview reference number

Example:"7858934895810"
external_ref_idstring

External reference ID (optional)

Example:"12345-46b5-464d-a8e4-afecc"
emailstring

Email address (optional)

Example:"participant@gmail.com"
languagestring

Language name (optional)

Example:"English"
curl -i -X POST \
  https://api.us.clearspeed.com/questionnaire/v1/participant \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_uuid": "fd9690b0-9050-4acd-ad74-7f906c07fe93",
    "phone_number1": "+916263877039",
    "phone_number2": "",
    "interview_ref_num": "7858934895810",
    "external_ref_id": "12345-46b5-464d-a8e4-afecc",
    "email": "participant@gmail.com",
    "language": "English"
  }'

Responses

Participant created, or — on a retake — the participant named by participant_uuid. Both modes return the same body.

Bodyapplication/json
project_uuidstring

UUID of the project/questionnaire

Example:"fd9690b0-9050-4acd-ad74-7f906c07fe93"
phone_number1string

Primary phone number

Example:"+916263877039"
phone_number2string

Secondary phone number

Example:""
interview_ref_numstring

Interview reference number

Example:"7858934895810"
external_ref_idstring

External reference ID

Example:"12345-46b5-464d-a8e4-afecc"
participant_uuidstring

UUID of the participant

Example:"01977df0-57c1-7dcf-8916-df741aa66691"
emailstring

Email address

Example:"participant@gmail.com"
languagestring

Participant language

Example:"English"
is_participant_allowedboolean

Whether participant is allowed after call-blocking checks

Example:true
outcomestring or null
outcome_tsstring or null
Response
{
  "project_uuid": "fd9690b0-9050-4acd-ad74-7f906c07fe93",
  "phone_number1": "+916263877039",
  "phone_number2": "",
  "interview_ref_num": "7858934895810",
  "external_ref_id": "12345-46b5-464d-a8e4-afecc",
  "participant_uuid": "01977df0-57c1-7dcf-8916-df741aa66691",
  "email": "participant@gmail.com",
  "language": "English",
  "particpant_guide_link": "https://guide.example.com?id=01977df0-57c1-7dcf-8916-df741aa66691",
  "is_participant_allowed": true,
  "outcome": null,
  "outcome_ts": null
}