Skip to main content
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
}
'
{
  "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

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
application_status
string
required

The identifier of the application status (applicant) to create the session for.

Pattern: ^[a-zA-Z0-9_]+$
​
send_email
boolean

Whether to send an email to the applicant with the session link.

Response

200 - application/json

Returns the application session object if the creation succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
application_session
​
application
required

The identifier of the application for the session.

​
application_status
required

The identifier of the applicant for the session.

​
customer
required

The identifier of the customer for the session.

​
mode
enum<string>
required

The mode of the application session.

Available options:
classic,
configuration
​
status
enum<string>
required

The status of the application session.

Available options:
pending,
complete,
canceled,
active,
expired
​
url
string
required

The URL of the application session hosted page.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.