reseller-customers
Add a customer or lead manually
Create a new lead or customer record. Resellers use this to track contacts from off-platform sources before they place an order.
POST
/
reseller
/
customers
Add a customer or lead manually
curl --request POST \
--url https://api.offergrid.io/reseller/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Doe",
"fullName": "Jane Doe",
"email": "jane@example.com",
"phone": "+1-555-123-4567",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94102",
"country": "US",
"kind": "lead",
"source": "manual",
"notes": "<string>",
"tags": [
"<string>"
],
"customFields": {
"sourceUrl": "https://example.com/listing/42"
}
}
'import requests
url = "https://api.offergrid.io/reseller/customers"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"fullName": "Jane Doe",
"email": "jane@example.com",
"phone": "+1-555-123-4567",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94102",
"country": "US",
"kind": "lead",
"source": "manual",
"notes": "<string>",
"tags": ["<string>"],
"customFields": { "sourceUrl": "https://example.com/listing/42" }
}
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({
firstName: 'Jane',
lastName: 'Doe',
fullName: 'Jane Doe',
email: 'jane@example.com',
phone: '+1-555-123-4567',
addressLine1: '123 Main St',
addressLine2: 'Apt 4B',
city: 'San Francisco',
state: 'CA',
postalCode: '94102',
country: 'US',
kind: 'lead',
source: 'manual',
notes: '<string>',
tags: ['<string>'],
customFields: {sourceUrl: 'https://example.com/listing/42'}
})
};
fetch('https://api.offergrid.io/reseller/customers', 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/customers",
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([
'firstName' => 'Jane',
'lastName' => 'Doe',
'fullName' => 'Jane Doe',
'email' => 'jane@example.com',
'phone' => '+1-555-123-4567',
'addressLine1' => '123 Main St',
'addressLine2' => 'Apt 4B',
'city' => 'San Francisco',
'state' => 'CA',
'postalCode' => '94102',
'country' => 'US',
'kind' => 'lead',
'source' => 'manual',
'notes' => '<string>',
'tags' => [
'<string>'
],
'customFields' => [
'sourceUrl' => 'https://example.com/listing/42'
]
]),
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/customers"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\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/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/reseller/customers")
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 \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\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"
}{
"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
Example:
"Jane"
Example:
"Doe"
Legacy single-field name — prefer firstName + lastName. Required only when both are absent; split on the last space when used.
Example:
"Jane Doe"
Example:
"jane@example.com"
Example:
"+1-555-123-4567"
Example:
"123 Main St"
Example:
"Apt 4B"
Example:
"San Francisco"
Example:
"CA"
Example:
"94102"
Example:
"US"
Whether to track as a lead (pre-order) or as a customer.
Available options:
lead, customer Where this contact came from.
Available options:
order, link, api_import, manual, event, shop, reseller Open-ended attributes (source URL, external IDs, etc.)
Example:
{
"sourceUrl": "https://example.com/listing/42"
}
Response
Customer created
Was this page helpful?
⌘I
Add a customer or lead manually
curl --request POST \
--url https://api.offergrid.io/reseller/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "Jane",
"lastName": "Doe",
"fullName": "Jane Doe",
"email": "jane@example.com",
"phone": "+1-555-123-4567",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94102",
"country": "US",
"kind": "lead",
"source": "manual",
"notes": "<string>",
"tags": [
"<string>"
],
"customFields": {
"sourceUrl": "https://example.com/listing/42"
}
}
'import requests
url = "https://api.offergrid.io/reseller/customers"
payload = {
"firstName": "Jane",
"lastName": "Doe",
"fullName": "Jane Doe",
"email": "jane@example.com",
"phone": "+1-555-123-4567",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postalCode": "94102",
"country": "US",
"kind": "lead",
"source": "manual",
"notes": "<string>",
"tags": ["<string>"],
"customFields": { "sourceUrl": "https://example.com/listing/42" }
}
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({
firstName: 'Jane',
lastName: 'Doe',
fullName: 'Jane Doe',
email: 'jane@example.com',
phone: '+1-555-123-4567',
addressLine1: '123 Main St',
addressLine2: 'Apt 4B',
city: 'San Francisco',
state: 'CA',
postalCode: '94102',
country: 'US',
kind: 'lead',
source: 'manual',
notes: '<string>',
tags: ['<string>'],
customFields: {sourceUrl: 'https://example.com/listing/42'}
})
};
fetch('https://api.offergrid.io/reseller/customers', 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/customers",
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([
'firstName' => 'Jane',
'lastName' => 'Doe',
'fullName' => 'Jane Doe',
'email' => 'jane@example.com',
'phone' => '+1-555-123-4567',
'addressLine1' => '123 Main St',
'addressLine2' => 'Apt 4B',
'city' => 'San Francisco',
'state' => 'CA',
'postalCode' => '94102',
'country' => 'US',
'kind' => 'lead',
'source' => 'manual',
'notes' => '<string>',
'tags' => [
'<string>'
],
'customFields' => [
'sourceUrl' => 'https://example.com/listing/42'
]
]),
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/customers"
payload := strings.NewReader("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\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/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.offergrid.io/reseller/customers")
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 \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"fullName\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone\": \"+1-555-123-4567\",\n \"addressLine1\": \"123 Main St\",\n \"addressLine2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"94102\",\n \"country\": \"US\",\n \"kind\": \"lead\",\n \"source\": \"manual\",\n \"notes\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {\n \"sourceUrl\": \"https://example.com/listing/42\"\n }\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"
}{
"statusCode": 404,
"message": "Offer not found",
"error": "Not Found"
}