Generate boarding link
Generates a boarding link from a boarding template.
Authentication
requestTokenstring
API Key authentication via header
Path parameters
ignoreEmpty
Ignore read-only and empty fields Default is false
. If ignoreEmpty
= false
and any field is empty, then the request returns a failure response. If ignoreEmpty
= true
, the request returns the boarding link name regardless of whether fields are empty.
templateId
The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80
. Here, the template ID is 80
.
Response
Success.
responseText
Response text for operation: ‘Success’ or ‘Declined’.
responseData
Reference name for boarding link (if responseText = Success) or
List of empty fields separated by comma (if responseText = Fail)