Incentives

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.

post/incentives/custom/log

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/incentives/custom/log
  • 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 log the custom incentive against. A maximum of 10 participants may be logged per request.

amountCentsinteger

Override 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

customIncentiveOptionIdstring

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

customIncentiveValuestring

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

allowDuplicateboolean

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

successboolean required

Whether the custom incentive was logged

isAsyncboolean required

Whether logging is processed asynchronously. Larger requests are queued and processed in the background

loggedIncentiveCountnumber

The number of participants the incentive was logged against

skippedParticipantIdsstring[]

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

Changes

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