API Reference

surveyRequest.create

post
https://api.ashbyhq.com/surveyRequest.create

This endpoint generates a survey request and returns a survey URL. You can send this URL to a candidate to allow them to complete a survey.

Requires the candidatesWrite permission.

Note that calling this endpoint will not automatically email the survey to the candidate. It simply creates the request and gives you a URL to share with a candidate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The id of the candidate to create a survey request for.

uuid
required

The id of the application to associate with the survey request.

uuid
required

The ID of the survey form that the candidate will see when they visit the URL returned in the surveyURL property of the API response. Survey forms IDs can be obtained using the surveyFormDefinition.list endpoint.

Response

Updated 22 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago