Invite Recipients
Remove an invite recipient
Removes a recipient from an invite, immediately invalidating their application link. The last remaining recipient on an invite cannot be removed. An invite can be amended as long as it hasn’t been canceled, expired, or converted into an application.
DELETE
/
v1
/
invite-recipients
/
{id}
Remove an invite recipient
curl --request DELETE \
--url https://api.theguarantors.com/v1/invite-recipients/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.theguarantors.com/v1/invite-recipients/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.theguarantors.com/v1/invite-recipients/{id}', 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/invite-recipients/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.theguarantors.com/v1/invite-recipients/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.theguarantors.com/v1/invite-recipients/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invite-recipients/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"message": "Missing authorization header",
"object": "error"
}{
"message": "cannot amend invite, property is inactive",
"error_code": "invite_property_inactive",
"object": "error"
}{
"message": "recipient not found",
"error_code": "invite_recipient_not_found",
"object": "error"
}{
"message": "cannot amend invite, a recipient has already accepted it",
"error_code": "invite_accepted",
"object": "error"
}{
"message": "cannot remove invite recipient, invite must have at least one recipient",
"error_code": "cannot_remove_last_recipient",
"object": "error"
}{
"message": "unable to remove invite recipient",
"error_code": "internal_error",
"object": "error"
}⌘I
Remove an invite recipient
curl --request DELETE \
--url https://api.theguarantors.com/v1/invite-recipients/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.theguarantors.com/v1/invite-recipients/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.theguarantors.com/v1/invite-recipients/{id}', 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/invite-recipients/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.theguarantors.com/v1/invite-recipients/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.theguarantors.com/v1/invite-recipients/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.theguarantors.com/v1/invite-recipients/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"message": "Missing authorization header",
"object": "error"
}{
"message": "cannot amend invite, property is inactive",
"error_code": "invite_property_inactive",
"object": "error"
}{
"message": "recipient not found",
"error_code": "invite_recipient_not_found",
"object": "error"
}{
"message": "cannot amend invite, a recipient has already accepted it",
"error_code": "invite_accepted",
"object": "error"
}{
"message": "cannot remove invite recipient, invite must have at least one recipient",
"error_code": "cannot_remove_last_recipient",
"object": "error"
}{
"message": "unable to remove invite recipient",
"error_code": "internal_error",
"object": "error"
}