Templates

Generate boarding link from template

Generates a boarding link from a boarding template.

get/Templates/getlink/{templateId}/{ignoreEmpty}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Templates/getlink/{templateId}/{ignoreEmpty}
  • Auth: HTTP bearer

Path parameters

ignoreEmptyboolean required

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.

templateIdnumber double required

The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.

Response

Success.

responseDatastring

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

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

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