☰
Send Surveys
Views
POST: https://{{env}}.survey2connect.com/v2/api/collectors/{{collect_id}}/campaigns
The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.
"Content-Type": "application/json"
type: Api Key Key: x-api-key token: value from portal
Request Parameters
{{collect_id}}: Unique Collector ID.
Request Body
{
"collectortoken": "E/f1a0f500",
"medium": 2,
"contacts": [{
"email": "john1@s2c.com",
"city": "Delhi"
}, {
"email": "john2@s2c.com",
"city": "Mumbai"
}]
}
Supported Filters
| Field | Type | Mandatory | Description |
| collectortoken | String | Yes |
It is unique for every collector. Can be captured from the platform.
|
| medium | Number | Yes |
1: SMS
2: Email 3: Whatsapp |
| contacts | Array | Yes |
Array for contacts to whom you want to trigger surveys. Also, you can send custom information of the respondents along with it.
‘email’ field is mandatory for medium 2. ‘mobile’ field is mandatory for medium 1. |
Request Sample
curl --location --request POST 'https://az1.survey2connect.com/v2/api/collectors/6375dad04b732a3b38d2f51b/campaigns' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJraWQiOiJzM3E1OWF2cFdIcXVKa0I0MjRpcFpqQVN0dXAzQzFkZEhVM3k2TjNZSXRjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0MTIxMDc1NC01ODVkLTRjNmQtODc2NC02Mzg0NzJkYTRhODEiLCJ6b25laW5mbyI6InByb2RfYXoxIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImN1c3RvbTpwYXNzd29yZFRvQmVSZXNldCI6ImZhbHNlIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLmFwLXNvdXRoLTEuYW1hem9uYXdzLmNvbVwvYXAtc291dGgtMV9zalNzc2JrOXYiLCJwaG9uZV9udW1iZXJfdmVyaWZpZWQiOmZhbHNlLCJjdXN0b206dUlkIjoiNjExYmEzNTcwZjdhNDEyNDYxM2MyMzg2IiwiY29nbml0bzp1c2VybmFtZSI6IjQxMjEwNzU0LTU4NWQtNGM2ZC04NzY0LTYzODQ3MmRhNGE4MSIsImF1ZCI6Ijg1azh1b2RqODBpazUzb2F0cDRycWJsYmMiLCJldmVudF9pZCI6ImI2ZmYzYjRhLWM3NGMtNGM1OC1hZmY3LTM3ZDYwN2IxOTZmMiIsInRva2VuX3VzZSI6ImlkIiwiYXV0aF90aW1lIjoxNjY5MDk2NTI0LCJjdXN0b206c3RhdHVzIjoiYWN0aXZlIiwibmFtZSI6IlRlc3QgRCIsInBob25lX251bWJlciI6Iis5MTc0MTc0NjExNzYiLCJleHAiOjE2NjkxODI5MjQsImN1c3RvbTpyb2xlIjoiYnJhbmRBZG1pbiIsImlhdCI6MTY2OTA5NjUyNCwiZW1haWwiOiJkYXZpbmRlci5zQHN1cnZleTJjb25uZWN0LmNvbSJ9.Ewk8USRvv9aToFd3Qv8TPvl9ApOjv_KgY_lcETX_DzUp3ASSt4cHk1sfJIOEN1h6EzD7pKPtLaoPapiCMUcG-7onvfY6JEQucUnYJaq_GDAfqiTYWJfBey_e1SKZxS6EbVjrFx1Wm3G_T-0sWoqS-M9tQtGB0KPEsRiTGgvxkJqcyBLI-q1RE4LCk-bdABOVVqSfXb__nndYPsj1jMiJKDXKcyPvRDk8Gg8lD5TQYRYDdLUiiZttDXK1y4p0ijwrBAjECQz_NCvbpJIXq2IkoNjWNQRIuVw9zI_bL5U1uSVJp_EC2q1mXiW3FKYFHaKC1vUshMcyHy_Rt_XAhaIWPQ' \
--data-raw '{
"collectortoken": "T/ae67354b",
"medium": 2,
"contacts": [{
"email": "john1@s2c.com",
"city": "Delhi"
}, {
"email": "john2@s2c.com",
"city": "Mumbai"
}]
}'
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer eyJraWQiOiJzM3E1OWF2cFdIcXVKa0I0MjRpcFpqQVN0dXAzQzFkZEhVM3k2TjNZSXRjPSIsImFs ");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"collectortoken": "E/f1a0f500",
"medium": 2,
"contacts": [
{
"email": "john1@s2c.com",
"city": "Delhi"
},
{
"email": "john2@s2c.com",
"city": "Mumbai"
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://az1.survey2connect.com/v2/api/collectors/62e20646bfbefb48636eaf50/campaigns", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
Responses
{
"msg": "Request data is correct",
"msgId": "632882b8927d9b1e87c2b790",
"data": {
"accepted": 2,
"rejected": 0,
"rejected_list": []
}
}
{
"error": {
"name": "Bad Request",
"message": "Collector not found"
}
}
{
"error": {
"name": "Unauthorized",
"message": "The authorization token was not provided."
}
}
{
"error": {
"name": "Internal Server Error",
"message": "We were not able to process your request"
}
}
Note: Please do not share your tokens in publicly accessible areas or to anyone. Also, this token generated is valid for 24 hours only. After its expiry, you can regenerate the access token from the same API endpoint by passing the username and password or from the refresh token API with the help of refresh token.