Share Survey

POST {{baseUrl}}/surveys/:surveyId/permissions/collaborations

Share a survey with another user in your brand. <!--From Readme--> <!-- theme: info -->

Limitations

The userId must be in the same brand as the user sharing the survey

userId Parameter Deprecated

If you previously used the userId body parameter in this API, that call will continue to work after the change to recipientId detailed above. You are encouraged to move to the new recipientId parameter detailed below, as the userId may be deprecated in the future.

See this example of typical values found in a request payload.

"recipients": "string",
"permissions": {
        "surveyDefinitionManipulation": {
            "copySurveyQuestions": false,
            "editSurveyFlow": false,
            "useBlocks": false,
            "useSkipLogic": false,
            "useConjoint": false,
            "useTriggers": false,
            "useQuotas": false,
            "setSurveyOptions": false,
            "editQuestions": false,
            "deleteSurveyQuestions": false,
            "useTableOfContents": false,
            "useAdvancedQuotas": false,
            "viewSurveys": false
        },
        "surveyManagement": {
            "editSurveys": false,
            "activateSurveys": false,
            "deactivateSurveys": false,
            "copySurveys": false,
            "distributeSurveys": false,
            "deleteSurveys": false,
            "translateSurveys": false
        },
        "response": {
            "editSurveyResponses": false,
            "createResponseSets": false,
            "viewResponseId": false,
            "useCrossTabs": false,
            "useScreenouts": false
        },
        "result": {
            "downloadSurveyResults": true,
            "viewSurveyResults": true,
            "filterSurveyResults": true,
            "viewPersonalData": true
        }  
      }
}
```<!-- attention -->

>#### The New `viewSurveys` Permission is a Meta Permission
> The new `viewSurveys` permission is a meta permission, which means that `viewSurveys` is enabled if any of the following permissions are enabled:
>
>- `editSurveys`
>- `translateSurveys`
>- `copySurveyQuestions`
>- `setSurveyOptions`
>- `createResponseSets`
>- `editQuestions`
>- `deleteSurveyQuestions`
>- `editSurveyFlow`
>- `editTextiQBasic`
>- `useBlocks`
>- `useAEConjoint`
>- `useAETriggers`
>- `useScreenouts`
>- `useAdvancedQuotas`
>- `useTableOfContents`
>- `useReferenceBlocks`
>
>You can’t explicitly set `viewSurveys` to `false` if any of this permission is enabled (we will override it). But you may set `viewSurveys` to `true` even if all permissions listed above are false.

Request Body

{"recipientId"=>"<string>", "permissions"=>{"aliquip_4"=>{"Excepteur1a"=>"<boolean>"}, "in7db"=>{"fugiat0"=>"<boolean>"}}, "userId"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"meta":{"httpStatus":"\u003cstring\u003e","requestId":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}