API Reference

Create a new crew

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

Creates a new crew with the specified details. A crew represents a roofing installation team that can be assigned to work orders and jobs. When a crew is created, an associated user account is automatically generated with login disabled by default. The crew will be associated with the authenticated user's company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Crew details including contact information, payment configuration, and associated trades and regions

string
required
length ≤ 50

Name of the crew

string | null

Contact phone number for the crew

string
required
length ≤ 100

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

trades
array of strings
required

Array of trade IDs this crew specializes in

trades*
regions
array of strings
required

Array of region IDs this crew operates in

regions*
string | null

Hex color code for visual identification

string | null

Additional notes or information about the crew

integer
Defaults to 4

Number of workers in the crew

string
enum
Defaults to 1

Priority level for scheduling and job assignment

Allowed:
string
required
length ≤ 100

Name of the person or entity to whom payments should be made

string | null

Street address for payment delivery

string | null

City for payment delivery

string | null

State or province code for payment delivery

string | null

ZIP or postal code for payment delivery

string
enum
Defaults to mail

Method by which payments will be delivered to the crew

Allowed:
string
enum
Defaults to current_friday

Payment schedule terms for the crew

Allowed:
integer
1 to 31
Defaults to 10

Day of the month when payment is due (1-31)

Responses

Updated 13 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago