Skip to main content
Bring Your Own Panel lets your respondent provider send people into a BYOP study through one entry URL. It is separate from individual participant invitations and from paid User Intuition Panel recruitment.
  1. Create and configure a study with recruiting_method: "byop" and review its saved plan.
  2. Confirm the study is provisioned and review its plan. Then PUT /api/public/v1/studies/{study_id}/external-panel with completion and screen-out redirect URLs. Optional settings map the provider’s respondent, session, or external study IDs and quota-full or technical-failure redirects.
  3. Give the returned entry_url to the provider after checking the parameter mapping and redirects. The provider substitutes its respondent ID in the entry URL. User Intuition creates a session and returns the respondent to the matching outcome URL.
  4. Use GET to inspect the current configuration. POST .../regenerate-token immediately invalidates the previous entry URL; use an Idempotency-Key for safe retries, then update the provider with the replacement. DELETE disables new entries without deleting completed interviews.
All configuration routes require an API key with read for GET or write for changes, plus access to the BYOP study. A paid Panel or synthetic-respondent study cannot use this integration. The entry_url is a live respondent link; handle it as a provider credential. The same workflow is available through the MCP tools get_external_panel, configure_external_panel, regenerate_external_panel_token, and delete_external_panel.