To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Journey action that allocates one voucher of a configured type to a profile. Looks up the voucher type named by voucherType, then allocates a single voucher, either to the lead's own profile or, when voucherAllocateMode is "specified", to a profile resolved from voucherAllocateToExpression. Optionally sets a custom cash value and extra field values on the allocated voucher, both of which may be literal text or a kcode expression evaluated against the lead. Always proceeds to the configured next node.
Group: Journeys
Extends: AbstractGoalAction
Properties
| Property | Returns | Description |
|---|---|---|
| voucherAllocateMode | String | Determines who receives the voucher: blank or null allocates to the lead's own profile, and "specified" allocates to the profile resolved from voucherAllocateToExpression. |
| voucherAllocateToExpression | String | Literal profile identifier (email or username) or kcode expression evaluated to find the recipient profile when voucherAllocateMode is "specified". |
| voucherCashValue | String | Literal value or kcode expression evaluated to set a custom cash value on the allocated voucher, used only when voucherCashValueEnabled is true. |
| voucherCashValueEnabled | Boolean | Whether voucherCashValue should be evaluated and applied as a custom cash value on the allocated voucher. |
| voucherFieldValues | Map<String,String> | Extra field values to set on the allocated voucher, keyed by field name, used only when voucherFieldValuesEnabled is true. Each value may be a literal string or a kcode expression evaluated against the lead. |
| voucherFieldValuesEnabled | Boolean | Whether voucherFieldValues should be evaluated and applied to the allocated voucher. |
| voucherType | String | Name of the voucher type to allocate a voucher from. |
Methods
getVoucherType()
Returns: String
Name of the voucher type to allocate a voucher from.
getVoucherCashValue()
Returns: String
Literal value or kcode expression evaluated to set a custom cash value on the allocated voucher, used only when voucherCashValueEnabled is true.
getVoucherFieldValues()
Returns: Map<String,String>
Extra field values to set on the allocated voucher, keyed by field name, used only when voucherFieldValuesEnabled is true. Each value may be a literal string or a kcode expression evaluated against the lead.
getVoucherCashValueEnabled()
Returns: Boolean
Whether voucherCashValue should be evaluated and applied as a custom cash value on the allocated voucher.
getVoucherFieldValuesEnabled()
Returns: Boolean
Whether voucherFieldValues should be evaluated and applied to the allocated voucher.
getVoucherAllocateMode()
Returns: String
Determines who receives the voucher: blank or null allocates to the lead's own profile, and "specified" allocates to the profile resolved from voucherAllocateToExpression.
getVoucherAllocateToExpression()
Returns: String
Literal profile identifier (email or username) or kcode expression evaluated to find the recipient profile when voucherAllocateMode is "specified".
© 2025 Kademi Ltd