Surveys

Endpoint

For managing Survey Contacts, the base url is:

@bulk_base/api/v1

Add Recipient

Method URI
POST /survey/contacts

Request Params

Param Type Description
survey_id string(required) Survey ID, retrieved from the portal
phone string(required) Phone number to be added to the survey.

Sample Request

{
    "survey_id": 3,
    "phone": "254716079675"
}

Sample Success Response

StatusCode 200

Content

{
    "status": true,
    "data": {
        "survey_id": 3,
        "phone": "254716079671",
        "unique_trace": "07160796713",
        "stage": 1,
        "updated_at": "2021-05-24 21:54:37",
        "created_at": "2021-05-24 21:54:37",
        "id": 2339,
        "current_question_id": 7,
        "date_created": "24 May, 2021 21:54",
        "survey_progress": "in progress...",
        "survey": {
            "id": 3,
            "title": "Test Survey",
            "description": null,
            "terminating_question": null,
            "client_id": 216,
            "short_code": 22471,
            "key_word": "PVAFC",
            "status": 0,
            "created_by": 22,
            "updated_by": null,
            "created_at": "2020-11-12 09:13:33",
            "updated_at": "2020-12-15 09:40:57",
            "date_created": "12 Nov, 2020 09:13",
            "date_updated": "15 Dec, 2020",
            "decoded_status": "Inactive"
        }
    }
}