Generate boarding link

Generates a boarding link from a boarding template.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

templateIddoubleRequired

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.

ignoreEmptybooleanRequired

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.

Response

Success.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDatastring or null

Reference name for boarding link (if responseText = Success) or
List of empty fields separated by comma (if responseText = Fail)

1	import { PayabliClient } from "@payabli/sdk-node";
2
3	async function main() {
4	const client = new PayabliClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.templates.getlinkTemplate(true, 80);
8	}
9	main();

Authentication

Path parameters

Response

Errors