Create Voucher Object

Sets a value in the voucher.

Resource URIs

URI Description

/admin/api/{API_KEY}/object/otp/{OBJECT_GUID}/create

Create a voucher

GET/POST Parameters

name
Optional. If specified, this value will be set as the name in the voucher.
company
Optional. If specified, this value will be set as the company in the voucher.
email
Optional. If specified, this value will be set as the email in the voucher.
sponsor
Optional. If specified, this value will be set as the sponsor in the voucher.
accessDays
Optional. If specified, this value will be set as the number of days of access in the voucher.
sms
Optional. If specified, this value will be set as the SMS in the voucher.
otp
Optional. If specified, this value will be set as the voucher in the voucher. If not specified, a random voucher will be generated.
sendEmail
Optional. Defaults to 1. If 1, the user will be emailed the voucher code (if an email is populated).
sendSms
Optional. Defaults to 1. If 1, the user will be sent the voucher code (if an SMS is populated) via SMS.
daysToRedeem
Optional. Defaults to 3. If specified, this is the number of days within which the voucher must be redeemed.

Examples

http://test.company.net/admin/api/zAdBCLcgrwca/object/otp/xyz/ create?name=bob&email=bob@test.com&sendEmail=1