An enrichment is never edited, and neither are its questions. To ask something different, create a new enrichment.
Questions
- 1 to 15 questions, each up to 300 characters, asked in the order you send them.
yes_nois answered with a tap and needs apreferred_answer(yesorno): the answer that counts as qualified.voiceis spoken or recorded and is not scored.requireddefaults totrue. A candidate is complete only after answering every required question.
Schedule
Channels
WhatsApp, the AI voice call and SMS are all on for every enrichment. There is nothing to choose or send.questions_status
Record translates the questions and records their voice in every language in the background.
Endpoints
Create an enrichment
POST /enrichments
Returns enrichment_id.
Scope: enrichment:write · Idempotency-Key: required
Response · 201
400 VALIDATION_FAILED (a field missing or wrong, a yes_no without preferred_answer, a start time not before the end time), 403 FORBIDDEN (a TEST key’s organisation already has 5 active enrichments: archive one in the Record playground), 409 CONFLICT (external_id already used).
List enrichments
GET /enrichments
Your organisation’s enrichments, made here or in the playground (is_external says which), newest first.
Scope: enrichment:read
Each item has the fields of the response above without
questions, and counts shows campaigns, candidates, sent (WhatsApp invites that went out) and completed (candidates who finished, including those who declined).
Get an enrichment
GET /enrichments/{enrichment_id}
One enrichment with its questions. Repeat it until questions_status is ready.
Scope: enrichment:read · Errors: 404 NOT_FOUND
Get the overview
GET /enrichments/{enrichment_id}/overview
Funnel numbers across all campaigns.
Scope: enrichment:read
Response · 200
standing counts candidates per status.
