Response Availability

Using the extUniqueId for survey link receipients, The response status can be checked.

POST https://{{env}}.survey2connect.com/v2/api/responses/availability

Path Parameters

Name	Type	Description
env*	String	Datacenter identifier for client

Headers

Name	Type	Description
Authorization	String	Bearer {access_token}

Request Body

Name	Type	Description
collectortoken*	String	Corresponding API collector unique token id (provided by platform)
contacts*	Array	An array of contacts to which surveys are to be triggered.

200: OK

{
  "data": [
    {
      "status": "Not responded",
      "extUniqueId": "123456"
    },
    {
      "status": "Not responded",
      "extUniqueId": "234567"
    }
  ],
  "msg": "Success"
}

400: Bad Request

{
  "error": {
    "name": "bad request",
    "message": "Invalid Collector token is present and no messages are exported"
  }
}

401: Unauthorized

{
  "error": {
    "name": "unauthorized",
    "message": "The authorization token was not provided"
  }
}

500: Internal Server Error

{
  "error": {
    "name": "internal server error",
    "message": "We couldn’t process your request"
  }
}