Set up bonuses
Authentication
Header authentication of the form Token <token>
Header authentication of the form Token <token>
Set up bonus payments to one or more participants/submissions in a study.
You need the study id, the participant|submission ids and the request in CSV format.
The csv_bonuses field needs to be structured in the format of either:
<participant_id>,<amount>\n.<submission_id>,<amount>\n.Note: The amount will be in the study currency. The amount should be a decimal value, e.g. 1.50 for £1.50. Warning: An amount of 30 will pay £/$30.00.
As an example, 60ffe5c8371090c7041d43f8,4.25 would be a bonus of £4.25 for participant 60ffe5c8371090c7041d43f8 in a study with GBP currency.
Setting up a bonus payment does not actually pay them, to do so check /api/v1/bulk-bonus-payments/{id}/pay/
The submission and participant IDs need to have taken part in the study in order for this call to be successful. If not, you will get a “400” HTTP response back, which explains which IDs are incorrect.