Creating Projects

Before you’re able to collect Responses, be it through embedding our Capture Widget or uploading your own pre-recorded videos, you will first need to create a Project. As this is the business entity that the majority Voxpopme processes revolve around, we provide many customisation options. The options you will need to specify will greatly depend on the depth of the integration you’re aiming for.

To start, send a POST request to https://developer.voxpopme.com/v2/question. For the vast majority of integration use cases, the below configuration is enough to create an operational Project, ready to receive Responses. As before, Projects in the API are referred to as Questions, but they mean the same thing.

const formData = new FormData();
formData.append('live', 'true');
formData.append('project_type', 'embed');
formData.append('campaign_name', 'Post-Summer Sale 2019 Study');
formData.append('question', 'Did you enjoy the Summer Sale this year?');
formData.append('further_info', 'What enticed you to participate?');
formData.append('start_time', '2019-09-01 00:00:00');
formData.append('expiry', '2019-10-01 00:00:00');
formData.append('responses_required', '200');
formData.append('locale', 'en_GB');

fetch('https://developer.voxpopme.com/v2/question', {
    method: 'POST',
    headers: {
        'x-api-key': 'your_api_key',
        'account-id': 'your_account_id',
    },
    body: formData
});

The Project created above will be able to accept a maximum of 200 Responses, during the entire month of September 2019. Once the Responses Required quota has been reached, or the Expiry date is in the past, you will no longer be able to create new Responses on that Project. We do not provide an option to have open-ended Projects. Therefore, we recommend to think about what the realistic Project requirements are, so expiry and responses_required can be set to sensible values. If needs be, set the end date to be far in the future.

There are many other fields you can specify to customise your Projects, the full list can be found in the API documentation, under POST /v2/question.