Partially update job

Performs a partial update of a job, allowing you to update only specific fields without providing the entire job object. All fields are optional. Note that insurance_claim and note fields cannot be updated (they are only available during creation). If customer.first_name is provided, it must still meet the minimum 1 character requirement

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Unique identifier of the job to update

Body Params

Partial job data for update. Only include fields that need to be changed. Cannot include insurance_claim or note fields

Comprehensive job information for updating a roofing project. All fields are optional during updates

string | null

Custom name or title for the job

string
enum
length ≤ 20
Defaults to r

Type of roofing job:

CodeMeaning
cCommercial
rResidential
dDesigner
mMRP (Maintenance and Repair Program)
Allowed:
string | null
enum

Type of bid or payment method:

CodeMeaning
cCash Bid
iInsurance Bid
rRepair
fFinance
Allowed:
integer | null

Unique identifier of the lead source (marketing channel or referral source)

string | null

Street address of the job location

string | null

City where the job is located

string | null

County where the job is located

string | null

Two-letter state or province code

string | null

Postal or ZIP code

integer | null

Unique identifier of the region or territory

integer | null

Unique identifier of the primary sales representative. Must be an employee from the authenticated user's company

integer | null

Unique identifier of the secondary sales representative. Must be an employee from the authenticated user's company

integer | null

Unique identifier of the marketing representative. Must be an employee from the authenticated user's company

integer | null

Unique identifier of the project manager. Must be an employee from the authenticated user's company

integer | null

Unique identifier of the property management company associated with this job

integer | null

Unique identifier of the pre-insurance reviewer. Must be an employee from the authenticated user's company

integer | null

Unique identifier of the post-insurance reviewer. Must be an employee from the authenticated user's company

date-time | null

ISO 8601 timestamp when the contract was signed by the customer

date-time | null

ISO 8601 timestamp when the work was completed

string | null

Marketing disclaimers or legal notices

string | null

Advertisement identifier for tracking

string | null

Advertisement name or title

string | null

Ad set identifier for campaign tracking

string | null

Ad set name or title

string | null

Marketing campaign identifier

string | null

Marketing campaign name

string | null

Marketing platform where the lead originated

string | null

Retailer item identifier for inventory tracking

string | null

CompanyCam project identifier for photo management integration

string | null

SalesRabbit company identifier

integer | null

SalesRabbit lead identifier

string | null

SalesRabbit representative identifier for the primary rep

string | null

SalesRabbit representative identifier for the secondary rep

boolean
Defaults to false

Indicates whether the warranty has been voided

boolean
Defaults to false

If true, excludes this job from QuickBooks synchronization

custom_data
object | null

Custom field data defined by the company. Structure varies based on company configuration

extra_info
object | null

Additional information storage. Structure is flexible and varies by use case

customer
object | null

Customer contact information. If provided, first_name must meet the minimum 1 character requirement

coordinates
object | null

Geographic coordinates specifying a location on Earth

created_from_location
object | null

Geographic coordinates specifying a location on Earth

lead_status_info
object | null

Lead status information tracking the current stage of the job in the sales pipeline

approved_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

submitted_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

rejected_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

pre_contract_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

closed_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

deleted_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

permitted_step
object | null

Generic workflow step information tracking when a stage was completed and by whom

verify_lead_step
object | null

Workflow step for verifying a lead, typically for insurance claims

adj_mtg_step
object | null

Workflow step for scheduling an adjuster meeting

inspection_step
object | null

Workflow step for scheduling and tracking an inspection

custom_steps
object | null

Dictionary of custom workflow steps. Keys must match the company's custom checklist item keys. Values are CustomStep objects

Responses

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