PUT
/
Boarding
/
applink
/
{appId}
/
{mail2}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Boarding/applink/{appId}/{mail2} \
  --header 'requestToken: <api-key>'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": {
    "appLink": "https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E",
    "referenceId": "n6UCd1f1ygG7"
  },
  "pageIdentifier": null
}

Authorizations

requestToken
string
header
required

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

Path Parameters

mail2
string
required

Email address used to access the application. If sendEmail parameter is true, a link to the application is sent to this email address.

appId
integer
required

Boarding application ID.

Example:

352

Query Parameters

sendEmail
boolean

If true, sends an email that includes the link to the application to the mail2 address. Defaults to false.

Response

200 - application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

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

Example:

"Success"

responseCode
integer | null

Code for the response. Learn more in API Response Codes.

Example:

1

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData
object | null

The object containing the response data.