API Reference

Create a new region

post
https://integrate.rooflink.com/roof_link_endpoints/api/light/regions/

Creates a new region with the specified details. A region represents a geographical territory or service area used for organizing operations, managing territories, and tracking performance. The region will be automatically associated with the authenticated user's company. If a color is not provided, one will be automatically generated. Geographic coordinates (latitude and longitude) are optional and will be used to set the region's geopoint for mapping features.

Body Params

Region details including contact information, timezone, DBA information, and geographic location

string
required
length ≤ 200

Name of the region

string
required
length ≤ 200

Region abbreviation or slug identifier (letters, numbers, hyphens, and underscores only)

string | null

Hex color code for visual identification (auto-generated if not provided)

string
enum
required
Defaults to US/Central

Timezone setting for the region

Allowed:
number

Job overhead percentage as a decimal (additional to company job overhead)

integer

Number of days customer has to cancel contract (Right of Rescission Period). Defaults to company setting if not provided.

string | null

County where law suits should be filed for this region

integer

Labor warranty period in years. Defaults to company setting if not provided.

string | null

Doing Business As name for this region

string | null

Doing Business As abbreviation

string | null

Doing Business As website URL

string | null

Better Business Bureau profile URL for the DBA

string | null

Facebook page URL for the DBA

string | null

Yelp page URL for the DBA

string
required
length ≤ 15

Contact phone number for the region (must be valid phone format)

string
required
length ≤ 200

Contact email address for the region (must be valid email format)

string | null

Employee ID of the office manager for this region (must be an active employee in the same company)

string | null

Street address of the region office

string | null

City name for the region office

string | null

State or province code for the region office

string | null

ZIP or postal code for the region office

string | null

Latitude coordinate for the region location (used with longitude to set internal geopoint for mapping)

string | null

Longitude coordinate for the region location (used with latitude to set internal geopoint for mapping)

abc_ship_to
object | null

ABC supplier ship-to account information as a JSON object (not an array or string)

srs_ship_to
object | null

SRS supplier ship-to account information as a JSON object

Responses

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago