Create customer and address only job

post

https://integrate.rooflink.com/roof_link_endpoints/api/light/jobs/address_only_lead/

Creates a new address-only lead (prospect) in the system with address, and location data. The lead can optionally include customer contact information such as name, email, and phone numbers.

Customer Record Creation:

This endpoint always creates a new customer record with each request. No duplicate checking or deduplication checks are performed.

Job Record: A new Job record is created and linked to the newly created customer.

Important Implications:

Multiple submissions with identical data will create duplicate records. If you submit the same address, email, or phone number multiple times, each submission will create separate customer, user, and job records. If deduplication is required for your use case, you must implement it in your application logic before calling this endpoint.

Accepted State/Province Codes:

The state field accepts the following standard postal abbreviations:

US States:

Code	State	Code	State	Code	State
AL	Alabama	AK	Alaska	AZ	Arizona
AR	Arkansas	CA	California	CO	Colorado
CT	Connecticut	DE	Delaware	FL	Florida
GA	Georgia	HI	Hawaii	ID	Idaho
IL	Illinois	IN	Indiana	IA	Iowa
KS	Kansas	KY	Kentucky	LA	Louisiana
ME	Maine	MD	Maryland	MA	Massachusetts
MI	Michigan	MN	Minnesota	MS	Mississippi
MO	Missouri	MT	Montana	NE	Nebraska
NV	Nevada	NH	New Hampshire	NJ	New Jersey
NM	New Mexico	NY	New York	NC	North Carolina
ND	North Dakota	OH	Ohio	OK	Oklahoma
OR	Oregon	PA	Pennsylvania	RI	Rhode Island
SC	South Carolina	SD	South Dakota	TN	Tennessee
TX	Texas	UT	Utah	VT	Vermont
VA	Virginia	WA	Washington	WV	West Virginia
WI	Wisconsin	WY	Wyoming	DC	District of Columbia

Canadian Provinces:

Code	Province/Territory
AB	Alberta
BC	British Columbia
MB	Manitoba
NB	New Brunswick
NL	Newfoundland and Labrador
NS	Nova Scotia
NT	Northwest Territories
NU	Nunavut
ON	Ontario
PE	Prince Edward Island
QC	Quebec
SK	Saskatchewan
YT	Yukon

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body containing the address, location coordinates, and optional customer contact information for creating a new address-only lead and job.

offline_id

string | null

External identifier for offline synchronization. Used when creating leads in offline mode that need to be reconciled later.

first_name

string | null

Customer's first name

last_name

string | null

Customer's last name

address

string

required

length ≤ 200

Street address of the property (required). This is the primary location identifier for the job.

city

string | null

City name. Defaults to empty string if not provided.

county

string | null

County name where the property is located

state

string

required

length ≤ 5

State or province code (required). Must be a valid US state or Canadian province abbreviation. See the Accepted State/Province Codes table in the endpoint description for the complete list of valid values.

zipcode

string

required

length ≤ 12

Postal code (required)

latitude

string

required

Latitude coordinate of the property location (required). Used to create the geopoint and determine the region.

longitude

string

required

Longitude coordinate of the property location (required). Used to create the geopoint and determine the region.

lead_status

string

enum

required

length ≤ 50

Lead status code indicating the current stage in the sales pipeline (required). Defaults to 'u' (Unknown) if not provided.

Accepted Values:

Code	Status Name	Description
pr	Prospect	Initial prospect/lead status
u	Unknown	Lead with unknown status (default)
a	Approved	Job has been approved
as	Assigned	Lead has been assigned to a sales rep
cb	Come Back Later	Customer wants to be contacted later
d	Dead	Lead is no longer viable
dn	Denied	Lead/job was denied
dd	Do Not Disturb	Customer requests not to be disturbed
de	Demo	Demo/presentation scheduled or completed
df	Denied Financing	Financing application was denied
dds	Discontinued Shingle	Shingle product discontinued
dnd	Absolutely Do Not Contact	Strong do-not-contact request
fu	Follow Up	Requires follow-up contact
ft	Future	Potential customer for future business

extra_info

object | null

Additional metadata about the lead stored as JSON. Can contain custom fields like campaign information, notes, or other contextual data.

cell

string | null

Customer's cell phone number. Will be stored as a mobile phone contact.

phone

string | null

Customer's home or office phone number. Will be stored as a home phone contact.

string | null

Customer's email address

source

string | null

Lead source ID indicating how the lead was acquired (e.g., referral, advertisement, door knocking). Must be a valid LeadSource ID for the company, or can be the string 'Door Knocking' to use the default door knocking source.

Responses

200Lead created successfully. Returns the newly created job with map display information including the job ID, coordinates, and status color for map visualization.

400Bad Request. The request contains invalid data or missing required fields. Check the field_errors in the response for specific validation failures.

401Unauthorized. Authentication credentials were not provided or are invalid. The request must include valid authentication tokens to access this endpoint.

403Forbidden. The authenticated user does not have permission to access this resource. This may be due to insufficient privileges, attempting to access resources from another company, or not meeting specific permission requirements for the operation.

429Too Many Requests. The client has exceeded the rate limit for this endpoint. Wait for the specified time period before making additional requests.

503Service Unavailable. The API rate limits for all public endpoints have been exceeded, or the service is temporarily down for maintenance. Try again later.