Invites
Create an invite
Creates an invite and sends an application link to each recipient.
POST
/
v1
/
invites
Create an invite
curl --request POST \
--url https://api.theguarantors.com/v1/invites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"property_id": "prop_nvlbcx2e5jk0fqsf",
"coverage_level": "medium",
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001"
}
},
"invite_recipients": [
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234"
},
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone_number": "+13475559876",
"metadata": {}
},
{
"first_name": "Alex",
"last_name": "Johnson",
"email": "alex.johnson@example.com",
"phone_number": "+16465550123",
"metadata": {}
}
],
"metadata": {}
}
'import requests
url = "https://api.theguarantors.com/v1/invites"
payload = {
"property_id": "prop_nvlbcx2e5jk0fqsf",
"coverage_level": "medium",
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001"
}
},
"invite_recipients": [
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234"
},
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone_number": "+13475559876",
"metadata": {}
},
{
"first_name": "Alex",
"last_name": "Johnson",
"email": "alex.johnson@example.com",
"phone_number": "+16465550123",
"metadata": {}
}
],
"metadata": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
property_id: 'prop_nvlbcx2e5jk0fqsf',
coverage_level: 'medium',
obligee: 'Acme Property Management LLC',
lease: {
start_date: '2026-03-01',
end_date: '2027-02-28',
monthly_rent: 320000,
prepaid_rent_amount: 120000,
free_rent_amount: 10000,
unit_address: {
line1: '123 Main St',
line2: 'Apt 5B',
city: 'New York',
state: 'NY',
postal_code: '10001'
}
},
invite_recipients: [
{
first_name: 'Jane',
last_name: 'Doe',
email: 'jane.doe@example.com',
phone_number: '+12125551234'
},
{
first_name: 'John',
last_name: 'Smith',
email: 'john.smith@example.com',
phone_number: '+13475559876',
metadata: {}
},
{
first_name: 'Alex',
last_name: 'Johnson',
email: 'alex.johnson@example.com',
phone_number: '+16465550123',
metadata: {}
}
],
metadata: {}
})
};
fetch('https://api.theguarantors.com/v1/invites', 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.theguarantors.com/v1/invites",
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([
'property_id' => 'prop_nvlbcx2e5jk0fqsf',
'coverage_level' => 'medium',
'obligee' => 'Acme Property Management LLC',
'lease' => [
'start_date' => '2026-03-01',
'end_date' => '2027-02-28',
'monthly_rent' => 320000,
'prepaid_rent_amount' => 120000,
'free_rent_amount' => 10000,
'unit_address' => [
'line1' => '123 Main St',
'line2' => 'Apt 5B',
'city' => 'New York',
'state' => 'NY',
'postal_code' => '10001'
]
],
'invite_recipients' => [
[
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jane.doe@example.com',
'phone_number' => '+12125551234'
],
[
'first_name' => 'John',
'last_name' => 'Smith',
'email' => 'john.smith@example.com',
'phone_number' => '+13475559876',
'metadata' => [
]
],
[
'first_name' => 'Alex',
'last_name' => 'Johnson',
'email' => 'alex.johnson@example.com',
'phone_number' => '+16465550123',
'metadata' => [
]
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.theguarantors.com/v1/invites"
payload := strings.NewReader("{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.theguarantors.com/v1/invites")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "inv_8f3k2jd9slq02mxp",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_q7ghmgtaavp37krc",
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
},
{
"id": "ivre_vd5t9qdhbhdx4iei",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_vd5t9qdhbhdx4iei",
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone_number": "+13475559876",
"metadata": {},
"object": "invite_recipient"
},
{
"id": "ivre_x3p7d9fk2qw8hn4c",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_x3p7d9fk2qw8hn4c",
"email": "alex.johnson@example.com",
"first_name": "Alex",
"last_name": "Johnson",
"phone_number": "+16465550123",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}{
"message": "validation error: start_date: cannot be blank.",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "operation not permitted on inactive property",
"object": "error"
}{
"message": "property not found",
"object": "error"
}{
"message": "internal server error",
"object": "error"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Invite to create
The coverage tier for the bond, which sets the number of months of rent it protects, from low (lowest) to high (highest). It is resolved to a coverage package using the coverages set up for the property, and every tier is subject to property support and applicant screening.
Available options:
low, medium, high Example:
"high"
The prospective residents to invite. An invite can have at most 6 recipients.
Required array length:
1 - 6 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"prop_ve2x7i0j6psdizy7"
Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.
The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.
Example:
"Rivermark Residential LLC"
Response
Created
Example:
"inv_01HQ8X"
Show child attributes
Show child attributes
The legal contract between a property manager and the tenant, as represented on invites. Identical to Lease, plus rent concession fields that are accepted when creating an invite and returned on invite responses. One of unit_address or unit_id is required.
Show child attributes
Show child attributes
Example:
"invite"
Example:
"prop_01HQ7A"
Available options:
created, accepted, canceled, expired Example:
"accepted"
Example:
"sd_01HQ8Z"
Optional key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.
The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.
Example:
"Rivermark Residential LLC"
⌘I
Create an invite
curl --request POST \
--url https://api.theguarantors.com/v1/invites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"property_id": "prop_nvlbcx2e5jk0fqsf",
"coverage_level": "medium",
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001"
}
},
"invite_recipients": [
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234"
},
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone_number": "+13475559876",
"metadata": {}
},
{
"first_name": "Alex",
"last_name": "Johnson",
"email": "alex.johnson@example.com",
"phone_number": "+16465550123",
"metadata": {}
}
],
"metadata": {}
}
'import requests
url = "https://api.theguarantors.com/v1/invites"
payload = {
"property_id": "prop_nvlbcx2e5jk0fqsf",
"coverage_level": "medium",
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001"
}
},
"invite_recipients": [
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "+12125551234"
},
{
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"phone_number": "+13475559876",
"metadata": {}
},
{
"first_name": "Alex",
"last_name": "Johnson",
"email": "alex.johnson@example.com",
"phone_number": "+16465550123",
"metadata": {}
}
],
"metadata": {}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
property_id: 'prop_nvlbcx2e5jk0fqsf',
coverage_level: 'medium',
obligee: 'Acme Property Management LLC',
lease: {
start_date: '2026-03-01',
end_date: '2027-02-28',
monthly_rent: 320000,
prepaid_rent_amount: 120000,
free_rent_amount: 10000,
unit_address: {
line1: '123 Main St',
line2: 'Apt 5B',
city: 'New York',
state: 'NY',
postal_code: '10001'
}
},
invite_recipients: [
{
first_name: 'Jane',
last_name: 'Doe',
email: 'jane.doe@example.com',
phone_number: '+12125551234'
},
{
first_name: 'John',
last_name: 'Smith',
email: 'john.smith@example.com',
phone_number: '+13475559876',
metadata: {}
},
{
first_name: 'Alex',
last_name: 'Johnson',
email: 'alex.johnson@example.com',
phone_number: '+16465550123',
metadata: {}
}
],
metadata: {}
})
};
fetch('https://api.theguarantors.com/v1/invites', 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.theguarantors.com/v1/invites",
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([
'property_id' => 'prop_nvlbcx2e5jk0fqsf',
'coverage_level' => 'medium',
'obligee' => 'Acme Property Management LLC',
'lease' => [
'start_date' => '2026-03-01',
'end_date' => '2027-02-28',
'monthly_rent' => 320000,
'prepaid_rent_amount' => 120000,
'free_rent_amount' => 10000,
'unit_address' => [
'line1' => '123 Main St',
'line2' => 'Apt 5B',
'city' => 'New York',
'state' => 'NY',
'postal_code' => '10001'
]
],
'invite_recipients' => [
[
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jane.doe@example.com',
'phone_number' => '+12125551234'
],
[
'first_name' => 'John',
'last_name' => 'Smith',
'email' => 'john.smith@example.com',
'phone_number' => '+13475559876',
'metadata' => [
]
],
[
'first_name' => 'Alex',
'last_name' => 'Johnson',
'email' => 'alex.johnson@example.com',
'phone_number' => '+16465550123',
'metadata' => [
]
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.theguarantors.com/v1/invites"
payload := strings.NewReader("{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.theguarantors.com/v1/invites")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"property_id\": \"prop_nvlbcx2e5jk0fqsf\",\n \"coverage_level\": \"medium\",\n \"obligee\": \"Acme Property Management LLC\",\n \"lease\": {\n \"start_date\": \"2026-03-01\",\n \"end_date\": \"2027-02-28\",\n \"monthly_rent\": 320000,\n \"prepaid_rent_amount\": 120000,\n \"free_rent_amount\": 10000,\n \"unit_address\": {\n \"line1\": \"123 Main St\",\n \"line2\": \"Apt 5B\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postal_code\": \"10001\"\n }\n },\n \"invite_recipients\": [\n {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"phone_number\": \"+12125551234\"\n },\n {\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john.smith@example.com\",\n \"phone_number\": \"+13475559876\",\n \"metadata\": {}\n },\n {\n \"first_name\": \"Alex\",\n \"last_name\": \"Johnson\",\n \"email\": \"alex.johnson@example.com\",\n \"phone_number\": \"+16465550123\",\n \"metadata\": {}\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "inv_8f3k2jd9slq02mxp",
"status": "created",
"property_id": "prop_nvlbcx2e5jk0fqsf",
"application_id": null,
"obligee": "Acme Property Management LLC",
"lease": {
"start_date": "2026-03-01",
"end_date": "2027-02-28",
"monthly_rent": 320000,
"prepaid_rent_amount": 120000,
"free_rent_amount": 10000,
"unit_address": {
"line1": "123 Main St",
"line2": "Apt 5B",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"object": "address"
},
"object": "lease"
},
"invite_recipients": [
{
"id": "ivre_q7ghmgtaavp37krc",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_q7ghmgtaavp37krc",
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+12125551234",
"metadata": {},
"object": "invite_recipient"
},
{
"id": "ivre_vd5t9qdhbhdx4iei",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_vd5t9qdhbhdx4iei",
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone_number": "+13475559876",
"metadata": {},
"object": "invite_recipient"
},
{
"id": "ivre_x3p7d9fk2qw8hn4c",
"link": "https://qualify.sandbox.theguarantors.com/invite/sign-up/ivre_x3p7d9fk2qw8hn4c",
"email": "alex.johnson@example.com",
"first_name": "Alex",
"last_name": "Johnson",
"phone_number": "+16465550123",
"metadata": {},
"object": "invite_recipient"
}
],
"metadata": {},
"object": "invite"
}{
"message": "validation error: start_date: cannot be blank.",
"object": "error"
}{
"message": "Missing authorization header",
"object": "error"
}{
"message": "operation not permitted on inactive property",
"object": "error"
}{
"message": "property not found",
"object": "error"
}{
"message": "internal server error",
"object": "error"
}