Configure External Panel
configure_external_panelCreate or replace a customer-supplied panel bridge on an owned BYOP study. Supply completion and screen-out redirect URLs; set the provider's respondent ID query parameter and placeholder if the defaults differ. Optional session, external study, quota-full, and technical-failure mappings are supported. Before sharing entry_url with the provider, call get_study, verify provisioning_status=provisioned, and have the human approve the current plan and URL mapping. This does not recruit respondents or launch the paid User Intuition Panel. Repeating the same PUT preserves the current entry token.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| provider | No | custom | |
| study_id | Yes | ||
| organization_id | No | Platform admins only: select an organization for this operation. Required when changing another organization’s study or using its wallet. | |
| session_id_param | No | ||
| respondent_id_param | No | respondent_id | |
| complete_redirect_url | Yes | ||
| screenout_redirect_url | Yes | ||
| session_id_placeholder | No | ||
| technical_redirect_url | No | ||
| external_study_id_param | No | ||
| quota_full_redirect_url | No | ||
| respondent_id_placeholder | No | {{RESPONDENT_ID}} | |
| external_study_id_placeholder | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Created or replaced external-panel configuration. |