reseller-links
Create a shareable link
Generate a shareable link for tenants to order services at a specific address. The link can be shared via email or SMS. Tenants can use the link to browse available offers and place orders without needing to create an account.
POST
/
reseller
/
links
Create a shareable link
curl --request POST \
--url https://api.offergrid.io/reseller/links \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"address": {
"street": "123 Main Street",
"city": "Austin",
"state": "TX",
"zipCode": "78701",
"country": "US",
"unit": "Unit 205"
},
"propertyName": "Sunset Apartments Unit 205",
"moveInDate": "2025-02-01"
}
'import requests
url = "https://api.offergrid.io/reseller/links"
payload = {
"address": {
"street": "123 Main Street",
"city": "Austin",
"state": "TX",
"zipCode": "78701",
"country": "US",
"unit": "Unit 205"
},
"propertyName": "Sunset Apartments Unit 205",
"moveInDate": "2025-02-01"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
street: '123 Main Street',
city: 'Austin',
state: 'TX',
zipCode: '78701',
country: 'US',
unit: 'Unit 205'
},
propertyName: 'Sunset Apartments Unit 205',
moveInDate: '2025-02-01'
})
};
fetch('https://api.offergrid.io/reseller/links', 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.offergrid.io/reseller/links",
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([
'address' => [
'street' => '123 Main Street',
'city' => 'Austin',
'state' => 'TX',
'zipCode' => '78701',
'country' => 'US',
'unit' => 'Unit 205'
],
'propertyName' => 'Sunset Apartments Unit 205',
'moveInDate' => '2025-02-01'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.offergrid.io/reseller/links"
payload := strings.NewReader("{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.offergrid.io/reseller/links")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/reseller/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}Authorizations
Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.
Body
application/json
Response
Link successfully created
Was this page helpful?
⌘I
Create a shareable link
curl --request POST \
--url https://api.offergrid.io/reseller/links \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"address": {
"street": "123 Main Street",
"city": "Austin",
"state": "TX",
"zipCode": "78701",
"country": "US",
"unit": "Unit 205"
},
"propertyName": "Sunset Apartments Unit 205",
"moveInDate": "2025-02-01"
}
'import requests
url = "https://api.offergrid.io/reseller/links"
payload = {
"address": {
"street": "123 Main Street",
"city": "Austin",
"state": "TX",
"zipCode": "78701",
"country": "US",
"unit": "Unit 205"
},
"propertyName": "Sunset Apartments Unit 205",
"moveInDate": "2025-02-01"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
street: '123 Main Street',
city: 'Austin',
state: 'TX',
zipCode: '78701',
country: 'US',
unit: 'Unit 205'
},
propertyName: 'Sunset Apartments Unit 205',
moveInDate: '2025-02-01'
})
};
fetch('https://api.offergrid.io/reseller/links', 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.offergrid.io/reseller/links",
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([
'address' => [
'street' => '123 Main Street',
'city' => 'Austin',
'state' => 'TX',
'zipCode' => '78701',
'country' => 'US',
'unit' => 'Unit 205'
],
'propertyName' => 'Sunset Apartments Unit 205',
'moveInDate' => '2025-02-01'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.offergrid.io/reseller/links"
payload := strings.NewReader("{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.offergrid.io/reseller/links")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/reseller/links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zipCode\": \"78701\",\n \"country\": \"US\",\n \"unit\": \"Unit 205\"\n },\n \"propertyName\": \"Sunset Apartments Unit 205\",\n \"moveInDate\": \"2025-02-01\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}