Incentives

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.

post/incentives

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/incentives
  • Auth: HTTP bearer

Request body

studyIdstring required

The ID of the study the participants belong to

participantIdsstring[] required

The IDs of the study participants to send the incentive to. A maximum of 10 participants may be sent to per request.

amountCentsinteger

Amount in cents for primary participants. Defaults to the study's incentive amount. Monetary incentives only

standbyAmountCentsinteger

Amount in cents for standby participants who never took the session. Defaults to the study's standby amount, else to amountCents

currency'AUD' | 'CAD' | 'EUR' | 'GBP' | 'NZD' | 'USD'

Override for the incentive currency. Defaults to the study's configured incentive currency. Applies to monetary incentives

incentiveBudgetIdstring

Override for the incentive budget to draw from. Defaults to the study's configured budget

updateToParticipantStatusIdstring

Override for the status participants are moved to after the incentive is sent. Defaults to the study's Incentive Sent status

allowDuplicateboolean

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

successboolean required

Whether the incentive send was accepted

isAsyncboolean required

Whether the send is processed asynchronously. Larger sends are queued and processed in the background

bulkActionRequestIdstring nullable required

The ID of the background bulk action when the send is processed asynchronously

hasInsufficientFundsForIncentivesboolean

True when the budget does not have enough funds

totalAvailableBalanceCentsnumber nullable

The available budget balance in cents

skippedParticipantIdsstring[]

Participants that were skipped because they already had an outstanding incentive for the study. Empty when allowDuplicate is true

Changes

No recorded changes to this operation across all 1 revision of this API.