| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://my.surveypal.com/api/rest | link | — | — | — |
Actions (33)
Surveys · 17
- Add email answerPUT /survey/{id}/answer/email
Add an email-based answer to the survey.
documented - Create email taskPUT /survey/{id}/emailtask
Create a new email task for the survey.
documented - Create external answerPUT /survey/{id}/answer/external
Create an external (non-email, non-SMS) answer for the survey.
documented - Create survey answerPUT /survey/{id}/answer
Create a new answer for the survey.
documented - Get answer countsGET /survey/{id}/answer/count
Get answer counts for the survey; supports filtering by state and channel.
documented - Get answer counts (old)GET /survey/{id}/answerCount
Old version of the answer-count endpoint; see the newer endpoint /survey/{id}/answer/count.
documented - Get surveyGET /survey/{id}
Get details of a specific survey.
documented - List survey answersGET /survey/{id}/answers
List answers for the survey.
documented - List survey elementsGET /survey/{id}/elements
List the elements (questions/fields) of the survey.
documented - List survey languagesGET /survey/{id}/languages
List available languages for the survey.
documented - List survey mergesGET /survey/{id}/merges
List merge fields for the survey.
documented - List surveysGET /surveys
List surveys owned by the authenticated user.
documented - Send SMS invitationPUT /survey/{id}/answer/sms/invite
Send an SMS invitation to the survey.
documented - Send batch SMS invitationsPUT /survey/{id}/answer/sms/invite/batch
Send a batch of SMS invitations for the survey.
documented - Send batch email invitationsPUT /survey/{id}/answer/email/invite/batch
Send a batch of email invitations for the survey.
documented - Send email invitationPUT /survey/{id}/answer/email/invite
Send an email invitation to the survey.
documented - Survey image previewGET /survey/{id}/preview
Get a preview image for the survey.
documented
Answers · 8
- Get answerGET /answer/{id}
Get details of a specific answer.
documented - Get answer dataGET /answer/{id}/data
Retrieve the actual data/content of the answer.
documented - Send reminderPOST /answer/{id}/sendReminder
Send a reminder email for the answer.
documented - Set answer elementPUT /answer/{id}/element/{element}
Set or update a value for a specific answer element.
documented - Set answer element by indexPUT /answer/{id}/element/{element}/{index}
Set a value for a specific element within an answer (by index).
documented - Set answer metaPUT /answer/{id}/meta
Add meta information to an answer.
documented - Set answer statePOST /answer/{id}/state
Change the state of an answer.
documented - Update answer dataPUT /answer/{id}/data
Create or update the actual data/content for the answer.
documented
Short URLs · 5
- Create short URLPUT /shorturl
Create a new short URL.
documented - Delete short URLDELETE /shorturl/{id}
Delete the short URL.
documented - Get short URLGET /shorturl/{id}
Get details of a specific short URL.
documented - List short URLsGET /shorturl
List all user short URLs.
documented - Update short URLPOST /shorturl/{id}
Update the short URL.
documented
Email Tasks · 3
- Activate email taskPOST /emailtask/{id}/activate
Activate the email task (if draft and templates exist).
documented - Create email task templatePUT /emailtask/{id}/templates
Create an email task template to use for the email task.
documented - Link answer to email taskPUT /emailtask/{id}/answers
Link an existing answer to the email task.
documented