# 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. You can also use this endpoint 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://docs.payabli.com/developers/api-reference/boarding/get-link-or-email-a-link-for-a-boarding-application

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get link or email a link for a boarding application
  version: endpoint_boarding.getExternalApplication
paths:
  /Boarding/applink/{appId}/{mail2}:
    put:
      operationId: get-external-application
      summary: Get link or email a link for a boarding application
      description: >-
        Retrieves a link and the verification code used to log into an existing
        boarding application. You can also use this endpoint 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.
      tags:
        - - subpackage_boarding
      parameters:
        - name: appId
          in: path
          description: 'Boarding application ID. '
          required: true
          schema:
            type: integer
        - name: mail2
          in: path
          description: >-
            Email address used to access the application. If `sendEmail`
            parameter is true, a link to the application is sent to this email
            address.
          required: true
          schema:
            type: string
        - name: sendEmail
          in: query
          description: >-
            If `true`, sends an email that includes the link to the application
            to the `mail2` address. Defaults to `false`.
          required: false
          schema:
            type: boolean
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_:PayabliApiResponse00'
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_:IsSuccess:
      type: boolean
    type_:PageIdentifier:
      type: string
    type_:Responsecode:
      type: integer
    type_:Responsedata:
      type: object
      additionalProperties:
        description: Any type
    type_:ResponseText:
      type: string
    type_:PayabliApiResponse00:
      type: object
      properties:
        isSuccess:
          $ref: '#/components/schemas/type_:IsSuccess'
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        responseCode:
          $ref: '#/components/schemas/type_:Responsecode'
        responseData:
          $ref: '#/components/schemas/type_:Responsedata'
        responseText:
          $ref: '#/components/schemas/type_:ResponseText'
      required:
        - responseText

```

## SDK Code Examples

```python Example Response
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.boarding.get_external_application(
    app_id=352,
    mail_2="mail2",
)

```

```typescript Example Response
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.boarding.getExternalApplication(352, "mail2");

```

```go Example Response
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgo "github.com/payabli/sdk-go"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Boarding.GetExternalApplication(
	context.TODO(),
	352,
	"mail2",
	&sdkgo.GetExternalApplicationRequest{},
)

```

```csharp Example Response
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Boarding.GetExternalApplicationAsync(
    352,
    "mail2",
    new GetExternalApplicationRequest()
);

```

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

```php Example Response
<?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();
```

```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()
```