Add Third-Party Accounts to Whitelist
Important Note
This feature is available in the Business plan. If you haven't upgraded yet, please upgrade before using this feature.
API Overview
- Function: Set Allowed Survey Respondents (Add Third-Party User IDs to Whitelist)
- Request Method: POST
- Request URL: /api/surveys/{survey_id}/respondent/access_list/batch?appid={appid}&access_token={access_token}
Request Parameters
| Parameter Name | Type | Location | Description | Example |
|---|---|---|---|---|
| survey_id | integer | uri | Survey ID | 9560808 |
| type | integer | body | Whitelist Type | Fixed value 11 for third-party login users |
| respondent_ids | array[integer] | body | Respondent ID List, maximum 100 users per request. Note: Use the respondent_id field from user information | [60000207891,60000207892,60000207893] |
Request Example
POST https://open.wesurvey.com/api/surveys/9560808/respondent/access_list/batch
{
"type":11,
"respondent_ids":[60000207891,60000207892,60000207893]
}
Response Example
{
"code": "OK",
"error": {
"type": ""
},
"data": {},
"request_id": "a51f36ef-1fd5-4537-9e9b-6e5054b99e15"
}
Error Codes
| error.type Code | Description |
|---|---|
| permission_denied | No Permission |
| invalid_list_length | Invalid List Length |
| invalid_type | Survey Has Other Active Whitelist Type, Please Disable It First in UI |
| invalid_argument | Parameter Validation Failed |
| user_not_found | User Not Found |