Send an incentive to study participants
Sends a standard (money / gift card) incentive to one or more study participants, mirroring the manual “Send Incentive” action in Rally. Larger sends are processed asynchronously.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Send the monetary incentive configured on a study to one or more of its participants. This mirrors the manual "Send Incentive" action in Rally: the incentive amount, email content, and sender all come from the study configuration, with amount / currency as the only overrides. Studies configured with a custom (logged) incentive must use POST /incentives/custom/log instead.
The ID of the study the participants belong to
The IDs of the study participants to send the incentive to. A maximum of 10 participants may be sent to per request.
1 - 10 elementsOverride for the incentive value in cents. Defaults to the study's configured incentive amount. Applies to monetary incentives, and to custom incentives configured as a monetary value
Override for the incentive currency. Defaults to the study's configured incentive currency. Applies to monetary incentives
AUD, CAD, EUR, GBP, NZD, USD Override for the incentive budget to draw from. Defaults to the study's configured budget
When provided, participants are moved to this status after the incentive is sent
By default, participants who already have an outstanding (not canceled or expired) incentive for this study are skipped and returned in skippedParticipantIds. Set to true to send anyway, allowing multiple incentives per participant
Response
The incentive send was accepted
The result of sending an incentive
Whether the incentive send was accepted
Whether the send is processed asynchronously. Larger sends are queued and processed in the background
The ID of the background bulk action when the send is processed asynchronously
True when the budget does not have enough funds
The available budget balance in cents
Participants that were skipped because they already had an outstanding incentive for the study. Empty when allowDuplicate is true