You can send email or SMS invitation to survey from your own service via Surveypal REST API.
NOTE: You can also use external links if you are able to send emails from your own system. External link is the easiest way for integration. See how to create external links.
How to use it?
First you need to create an API credentials.
- Here are instructions how to create Basic authentication credentials
- If your Surveypal organization is created before 31.08.2022 then you can use also API key for authentication.
- Make sure that the survey or surveys are made with the same user name who created the API credentials or share surveys to this user.
Email invitations
Use request /survey/{id}/answer/email/invite or if you need to send multiple invitations same time then you can use request /survey/{id}/answer/email/invite/batch
- Replace {id} with your survey ID. You can find ID from Surveypal survey list when select survey and scroll down. After survey links there is also survey ID.
You can define email message in your API request or save invitation message in Surveypal. We recommend to save message in Surveypal so you don't need to change REST request when you need to change the message.
SMS invitations
Before you can send SMS messages Surveypal needs to configure SMS channel for your organization. Send email to helpdesk@surveypal.com, we will tell you the SMS price and configure the channel to your organization.
Use request /survey/{id}/answer/sms/invite or if you need to send multiple invitations same time then you can use request /survey/{id}/answer/sms/invite/batch
- Replace {id} with your survey ID. You can find ID from Surveypal survey list when select survey and scroll down. After survey links there is also survey ID.
This request needs "Subject" information but we don't use it with SMS invitation so you can add there some text like "test" and it's enough.
You can define SMS message in your API request or save invitation message in Surveypal. We recommend to save message in Surveypal so you don't need to change REST request when you need to change message.
NOTE: character limit for one SMS message is 160 and Surveypal short link takes 21 characters so your message must be less than 139 characters.