GET
/
Templates
/
getlink
/
{templateId}
/
{ignoreEmpty}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

templateId
number
required

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.

ignoreEmpty
boolean
default:
false
required

Ignore readOnly 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

200 - application/json
responseData
string | null

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

responseText
string | null

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