> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/api-reference/boarding/get-link-or-email-a-link-for-a-boarding-application/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get or send boarding link

PUT https://api-sandbox.payabli.com/api/Boarding/applink/{appId}/{mail2}

Retrieves a link and the verification code used to log into an existing boarding application. This endpoint can also be used to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.

Reference: https://beta-docs.payabli.com/api-reference/boarding/get-link-or-email-a-link-for-a-boarding-application

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `appId` (integer, required) — Boarding application ID.
- `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.

### Query parameters

- `sendEmail` (boolean, optional) — If `true`, sends an email that includes the link to the application to the `mail2` address. Defaults to `false`.

## Response

### 200

Success

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components.
- `responseCode` (integer, optional) — Code for the response. Learn more in [API Response Codes](/api-reference/api-responses).
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Examples

**Response**

```json
{
  "isSuccess": true,
  "responseCode": 1,
  "responseData": {
    "appLink": "https://boarding-sandbox.payabli.com/boarding/externalapp/load/17E",
    "referenceId": "n6UCd1f1ygG7"
  },
  "responseText": "Success"
}
```

**SDK Code**

```python Example Response
import requests

url = "https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2"

headers = {"requestToken": "<apiKey>"}

response = requests.put(url, headers=headers)

print(response.json())
```

```javascript Example Response
const url = 'https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2';
const options = {method: 'PUT', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example Response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example Response
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Example Response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php Example Response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Example Response
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2");
var request = new RestRequest(Method.PUT);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Example Response
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Boarding/applink/352/mail2")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> If you're a software company, you're a payments company™