Application Sessions
Create an application session
Creates a new application session for the specified application.
POST
/
v1
/
application_sessions
Create an application session
curl --request POST \
--url https://api.yorlet.com/v1/application_sessions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"application_status": "<string>",
"send_email": true
}
'import requests
url = "https://api.yorlet.com/v1/application_sessions"
payload = {
"application_status": "<string>",
"send_email": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({application_status: '<string>', send_email: true})
};
fetch('https://api.yorlet.com/v1/application_sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/application_sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_status' => '<string>',
'send_email' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/application_sessions"
payload := strings.NewReader("{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/application_sessions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/application_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "application_session",
"application": "<string>",
"application_status": "<string>",
"customer": "<string>",
"mode": "classic",
"status": "pending",
"url": "<string>",
"account": "<string>",
"deleted": false
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
application/json
Response
200 - application/json
Returns the application session object if the creation succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
application_session The identifier of the application for the session.
The identifier of the applicant for the session.
The identifier of the customer for the session.
The mode of the application session.
Available options:
classic, configuration The status of the application session.
Available options:
pending, complete, canceled, active, expired The URL of the application session hosted page.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?
Create an application session
curl --request POST \
--url https://api.yorlet.com/v1/application_sessions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"application_status": "<string>",
"send_email": true
}
'import requests
url = "https://api.yorlet.com/v1/application_sessions"
payload = {
"application_status": "<string>",
"send_email": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({application_status: '<string>', send_email: true})
};
fetch('https://api.yorlet.com/v1/application_sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/application_sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_status' => '<string>',
'send_email' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/application_sessions"
payload := strings.NewReader("{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/application_sessions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/application_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_status\": \"<string>\",\n \"send_email\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "application_session",
"application": "<string>",
"application_status": "<string>",
"customer": "<string>",
"mode": "classic",
"status": "pending",
"url": "<string>",
"account": "<string>",
"deleted": false
}