Log a custom incentive for study participants
Logs the study’s configured custom incentive (for example swag or cash handed out outside Rally) against one or more participants. Custom incentives are recorded in Rally, not sent by email.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Log the custom incentive configured on a study (for example swag or cash handed out to people outside Rally) against one or more of its participants. Custom incentives are recorded in Rally, not sent; the custom incentive itself comes from the study configuration, with the option / value / amount as the only overrides.
The ID of the study the participants belong to
The IDs of the study participants to log the custom incentive against. A maximum of 10 participants may be logged per request.
1 - 10 elementsOverride for the logged value in cents. Only applies when the study's custom incentive is a monetary value. Defaults to the study's configured amount
Override for the selected custom incentive option. Only applies when the study's custom incentive is single-select. Defaults to the study's configured default option
Override for the logged custom incentive value. Only applies when the study's custom incentive is not single-select. Defaults to the study's configured default value
By default, participants who already have an outstanding custom incentive for this study are skipped and returned in skippedParticipantIds. Set to true to log anyway, allowing multiple custom incentives per participant
Response
The custom incentive log was accepted
The result of logging a custom incentive
Whether the custom incentive was logged
Whether logging is processed asynchronously. Larger requests are queued and processed in the background
The number of participants the incentive was logged against
Participants that were skipped because they already had an outstanding custom incentive for the study. Empty when allowDuplicate is true