Cancel an invite

curl --request POST \
  --url https://api.theguarantors.com/v1/invites/{id}/cancel \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "The unit is no longer available"
}
'

import requests

url = "https://api.theguarantors.com/v1/invites/{id}/cancel"

payload = { "reason": "The unit is no longer available" }
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({reason: 'The unit is no longer available'})
};

fetch('https://api.theguarantors.com/v1/invites/{id}/cancel', 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/{id}/cancel",
  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([
    'reason' => 'The unit is no longer available'
  ]),
  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/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"The unit is no longer available\"\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/{id}/cancel")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"The unit is no longer available\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.theguarantors.com/v1/invites/{id}/cancel")

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  \"reason\": \"The unit is no longer available\"\n}"

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

{
  "id": "inv_8f3k2jd9slq02mxp",
  "status": "canceled",
  "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"
    }
  ],
  "metadata": {},
  "object": "invite"
}

{
  "message": "validation error: reason: the length must be between 1 and 1000.",
  "object": "error"
}

{
  "message": "Missing authorization header",
  "object": "error"
}

{
  "message": "invite not found",
  "object": "error"
}

{
  "application_id": "sd_3k29dls92jf83kdl",
  "message": "invite is already converted to application, please see application_id in response",
  "object": "error"
}

{
  "message": "internal server error",
  "object": "error"
}