Actions

Actions reference

Every change an API key or an AI assistant can make: 509 actions, each the same code HailMate’s own screens run, done as the person who made the key.

Calling an action

POST /v1/actions/{name} with { "input": { … } }. The answer is { "object": "action_result", "action": "<name>", "data": { … } }, and a refusal names the field to fix. Send an Idempotency-Key with every change so a retried request never makes it twice. GET /v1/actions answers this list as JSON; AI assistants use list_actions, get_action and run_action (Claude, ChatGPT & Gemini).

Shell
curl https://app.hailmate.ai/api/v1/actions/record_processor_payment \
  -H "Authorization: Bearer hm_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: square-8kq2-0001" \
  -d '{"input": {"processor": "Square", "reference": "8kq2", "amount": 1250}}'

Everyday changes

accept_photo_suggestions

Use the suggested captions and tags on photos.

FieldTypeRequired
file_idslist of textyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

add_analytics_chart

Add a chart to the charts in Reports.

FieldTypeRequired
idtext
teamtrue or falseyes
titletext
specobjectyes
sizeone of `half`, `full`yes
originone of `person`, `hailey`, `starter`yes
placeone of `top`, `bottom`yes
Example request body
{
  "input": {
    "team": false,
    "spec": {},
    "size": "half",
    "origin": "person",
    "place": "bottom"
  }
}

add_crew_day_off

Mark days a crew is off.

FieldTypeRequired
crew_idtextyes
ends_ontextyes
reasontext
starts_ontextyes
idtext
Example request body
{
  "input": {
    "crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "ends_on": "2026-11-19",
    "starts_on": "2026-11-19"
  }
}

add_estimate_photo

Add a photo or document to an estimate.

FieldTypeRequired
captiontext
created_attext
display_ordernumber
estimate_idtextyes
file_idtext
file_nametext
file_size_bytesnumber
idtext
include_in_pdftrue or false
media_kindtext
mime_typetext
photo_urltextyes
section_idtext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "photo_url": "photo url"
  }
}

add_estimate_signer

Add a signer to an estimate.

FieldTypeRequired
estimate_idtextyes
signer_emailtextyes
signer_nametextyes
signer_ordernumber
signer_roletext
idtext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signer_email": "dana@example.com",
    "signer_name": "signer name"
  }
}

add_job_activity

Add a line to a job timeline.

FieldTypeRequired
descriptiontext
job_idtextyes
metadataany
titletextyes
typetextyes
idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "title": "title",
    "type": "type"
  }
}

add_job_checklist

Add a checklist to a job.

FieldTypeRequired
idtextyes
job_idtextyes
nametextyes
template_idtext
itemslist of objectyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "name": "name",
    "items": [
      {
        "label": "label"
      }
    ]
  }
}

add_job_checklist_item

Add an item to a job's checklist.

FieldTypeRequired
checklist_idtextyes
headingtext
job_idtextyes
labeltextyes
notetext
photo_file_idtext
positionnumber
quantitynumber
statustext
status_attext
unittext
idtextyes
Example request body
{
  "input": {
    "checklist_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "label": "label",
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

add_job_checklist_item_photos

Add photos to an item on a job's checklist.

FieldTypeRequired
item_idtextyes
job_idtextyes
file_idslist of textyes
at_starttrue or false
Example request body
{
  "input": {
    "item_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

add_job_person

Put someone on a job.

FieldTypeRequired
contact_idtextyes
created_attext
idtext
job_idtextyes
roletextyes
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "role": "role"
  }
}

add_job_tags

Tag several jobs.

FieldTypeRequired
idslist of textyes
tagslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "tags": [
      "tag"
    ]
  }
}

add_pin_photos

Save photos on a pin.

FieldTypeRequired
photoslist of objectyes
Example request body
{
  "input": {
    "photos": [
      {
        "file_path": "file path",
        "pin_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ]
  }
}

add_punch_item

Add an item to a work order's punch list.

FieldTypeRequired
idtextyes
work_order_idtextyes
texttextyes
positionwhole number
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "text": "text"
  }
}

add_showcase_photos

Put photos on the showcase page.

FieldTypeRequired
file_idslist of textyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

add_supplement_case_event

Add a line to a supplement case's history.

FieldTypeRequired
case_idtextyes
kindtextyes
payloadobjectyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "kind": "kind",
    "payload": {}
  }
}

add_supplement_hand_item

Add an item the review missed.

FieldTypeRequired
amountnumber
buckettextyes
carrier_line_idslist of text
carrier_qtynumber
case_idtextyes
codetext
confidencenumber
correct_qtynumber
coveragetext
delta_qtynumber
engine_includedtrue or false
evidence_file_idslist of text
evidence_requiredlist of text
familytextyes
gatetext
gate_fieldtext
idtext
includedtrue or false
issuetextyes
itemtextyes
justifyany
notetext
override_qtynumber
override_unit_pricenumber
percenttrue or false
price_sourcetext
priorany
prioritytext
questiontext
ranknumber
rule_keytextyes
shottext
trigger_facttext
unittextyes
unit_pricenumber
versionnumberyes
whytext
win_probabilitynumber
Example request body
{
  "input": {
    "bucket": "bucket",
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "family": "family",
    "issue": "issue",
    "item": "item",
    "rule_key": "rule key",
    "unit": "unit",
    "version": 1
  }
}

add_work_order_log

Write the day's log on a work order.

FieldTypeRequired
idtextyes
work_order_idtextyes
notetextyes
daytext
file_idslist of text
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "note": "note"
  }
}

add_work_order_shot

Use a job photo for one of a work order's required shots.

FieldTypeRequired
work_order_idtextyes
shottextyes
file_idtextyes
Example request body
{
  "input": {
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "shot": "shot",
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

adopt_sample_job_into_board

Put the sample job on a board.

FieldTypeRequired
pipeline_idtextyes
stagetextyes
Example request body
{
  "input": {
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage": "stage"
  }
}

answer_material_order_question

Answer a material order's question.

FieldTypeRequired
order_idtextyes
keyone of `pipes`, `vents`, `skylights`, `chimneys`, `waste`, `edges`, `flashing`, `colors`yes
valuenumberyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "key": "pipes",
    "value": 0
  }
}

approve_material_order

Approve a material order to send.

FieldTypeRequired
order_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

assign_email_conversation

Hand an email conversation to a teammate.

FieldTypeRequired
thread_idtextyes
user_idtextyes
Example request body
{
  "input": {
    "thread_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

assign_supplement_intake

File an arrived carrier estimate on a job.

FieldTypeRequired
intake_idtextyes
job_idtextyes
engine_modeone of `on`, `shadow`, `off`
Example request body
{
  "input": {
    "intake_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

assign_text_conversation

Hand a company line text conversation to a teammate.

FieldTypeRequired
conversation_idtextyes
user_idtextyes
Example request body
{
  "input": {
    "conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

attach_photo_original

Attach the full-size original to a photo.

FieldTypeRequired
file_pathtextyes
original_pathtextyes
Example request body
{
  "input": {
    "file_path": "file path",
    "original_path": "original path"
  }
}

attach_pin_photo_original

Attach the full-size original to a pin's photo.

FieldTypeRequired
file_pathtextyes
original_pathtextyes
Example request body
{
  "input": {
    "file_path": "file path",
    "original_path": "original path"
  }
}

attach_sender_to_contact

Add a phone number or email to a contact.

FieldTypeRequired
contact_idtextyes
phonetext
emailtext (email)
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Attach the EagleView report at this job's address, if there is one.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Attach the Hover report at this job's address, if there is one.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

build_insurance_package

Build the final insurance package PDF.

FieldTypeRequired
job_idtextyes
document_idtext
invoice_idslist of text
include_photostrue or false
file_idslist of text
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

build_supplement_package

Build the supplement package.

FieldTypeRequired
case_idtextyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

bulk_update_work_orders

Change many work orders at once (crew, days, status).

FieldTypeRequired
idslist of textyes
crew_idtext
sub_company_idtext
clear_crewtrue or false
clear_daystrue or false
shift_dayswhole number
statusone of `ready`, `scheduled`, `in_progress`, `needs_check`, `done`, `canceled`
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

cancel_queued_follow_up

Stop a follow-up waiting to go out on a job.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

cancel_queued_message

Cancel a text or email waiting to send.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

cancel_scheduled_email

Cancel a scheduled email.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

cancel_sms_broadcast

Cancel a text broadcast.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

change_job_person_role

Change what someone does on a job.

FieldTypeRequired
idtextyes
roletextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "role": "role"
  }
}

change_other_buildings

Add or remove a building on a job's roof measurement.

FieldTypeRequired
job_idtextyes
addobject
remove_indexwhole number
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

check_affirm_status

Check the Affirm setup with Stripe.

It takes no input.

Example request body
{
  "input": {}
}

check_boldsign_sender_status

Check whether the contract sender address is approved.

It takes no input.

Example request body
{
  "input": {}
}

check_stripe_setup

Check where the Stripe setup is.

It takes no input.

Example request body
{
  "input": {}
}

clear_default_email_signature

Stop adding a signature automatically.

It takes no input.

Example request body
{
  "input": {}
}

copy_estimate

Copy an estimate.

FieldTypeRequired
source_idtextyes
job_idtext
titletext
as_templatetrue or false
Example request body
{
  "input": {
    "source_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

copy_estimate_signers

Copy the signers onto a new estimate.

FieldTypeRequired
source_estimate_idtextyes
new_estimate_idtextyes
Example request body
{
  "input": {
    "source_estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "new_estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

copy_photos_to_job

Copy photos onto another job.

FieldTypeRequired
file_idslist of textyes
job_idtextyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

copy_workspace_contacts

Copy contacts from another of your companies.

FieldTypeRequired
source_workspace_idtextyes
typeslist of text
dry_runtrue or falseyes
contacts_modeone of `all`, `picked`, `none`
contact_idslist of text
jobs_modeone of `all`, `picked`, `none`
job_idslist of text
stage_mapobject
default_stage_keytext
copy_job_historytrue or false
Example request body
{
  "input": {
    "source_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "dry_run": true
  }
}

create_change_order

Start a change order.

FieldTypeRequired
source_idtextyes
basenumberyes
Example request body
{
  "input": {
    "source_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "base": 1
  }
}

create_communication_log

Log an email, text or call.

FieldTypeRequired
ai_draftedtrue or false
ai_summarytext
bodytext
body_htmltext
call_durationnumber
call_routeany
call_statustext
cc_emailslist of text
contact_idtext
created_attext
delivered_attext
delivery_errortext
directiontext
estimate_idtext
external_message_idtext
from_emailtext
idtext
in_reply_totext
invoice_idtext
job_idtext
media_urlslist of text
message_idtext
opened_attext
phone_number_idtext
read_attext
recipienttextyes
recipient_nametext
recording_pathtext
sent_attext
sms_conversation_idtext
statustext
subjecttext
supplement_submission_idtext
thread_idtext
to_emailslist of text
typetextyes
user_email_account_idtext
user_idtext
waveform_peakslist of number
Example request body
{
  "input": {
    "recipient": "recipient",
    "type": "type"
  }
}

create_contact

Add a contact.

FieldTypeRequired
additional_phonesany
addresstext
adjuster_extensiontext
adjuster_typetext
assigned_totext
citytext
claim_numbertext
companytext
custom_fieldsany
emailtext
first_nametext
gate_codetext
idtext
languagetext
last_nametext
notestext
phonetext
phone_labeltext
sms_consenttrue or false
sms_consent_attext
sms_consent_methodtext
statetext
tradeslist of text
typetextyes
ziptext
Example request body
{
  "input": {
    "type": "type"
  }
}

create_email_signature

Save a new email signature.

FieldTypeRequired
nametextyes
bodytextyes
is_defaulttrue or falseyes
formatone of `text`, `designed`, `html`
designany
htmltext
Example request body
{
  "input": {
    "name": "name",
    "body": "body",
    "is_default": true
  }
}

create_email_template

Save an email template.

FieldTypeRequired
bodytextyes
is_sharedtrue or false
nametextyes
subjecttext
Example request body
{
  "input": {
    "body": "body",
    "name": "name"
  }
}

create_estimate

Start an estimate.

FieldTypeRequired
allow_multiple_optionstrue or false
approval_statustext
approved_marginnumber
best_includes_bettertrue or false
best_package_descriptiontext
best_package_enabledtrue or false
best_package_nametext
better_package_descriptiontext
better_package_enabledtrue or false
better_package_nametext
certification_idslist of text
change_order_basenumber
cover_company_addresstext
cover_company_emailtext
cover_company_logo_urltext
cover_company_nametext
cover_company_phonetext
cover_homeowner_greetingtext
cover_intro_texttext
cover_layouttext
cover_logo_scalenumber
cover_photo_focus_xnumber
cover_photo_focus_ynumber
cover_property_photo_urltext
created_attext
default_margin_percentnumber
document_typetext
expires_attext
good_package_descriptiontext
good_package_enabledtrue or false
good_package_nametext
idtext
import_file_idtext
import_sourcetext
is_proposaltrue or false
is_sampletrue or false
is_templatetrue or false
job_idtext
lost_reasontext
lost_reason_notetext
notestext
package_discountsany
package_price_overridesany
package_ratesany
packages_are_standalonetrue or false
parent_estimate_idtext
profitability_typetext
proposal_cover_titletext
proposal_footer_texttext
render_enginetext
roof_squaresnumber
round_quantitiestrue or false
scope_headingtext
selected_option_keyslist of text
selected_tiertext
selected_upgrade_idslist of text
selected_warranty_option_idtext
show_line_item_pricestrue or false
show_line_item_quantitiestrue or false
show_line_item_totalstrue or false
show_line_item_unit_pricetrue or false
show_line_item_uomtrue or false
signature_field_defsany
signature_methodtext
signature_page_numbernumber
signer_emailtext
signer_nametext
signing_order_enabledtrue or false
tax_ratenumber
terms_and_conditionstext
titletext
updated_attext
valid_untiltext
Example request body
{
  "input": {
    "allow_multiple_options": true
  }
}

create_estimate_line_item

Add a line to an estimate.

FieldTypeRequired
base_quantitynumber
created_attext
descriptiontext
display_ordernumber
estimate_idtextyes
idtext
is_optionaltrue or false
margin_linkedtrue or false
material_costnumber
measurement_fieldtext
measurement_idtext
nametextyes
product_idtext
profit_amountnumber
profit_margin_percentnumber
quantitynumber
section_idtext
tiertext
unit_pricenumber
uomtextyes
updated_attext
waste_percentnumber
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "name": "name",
    "uom": "uom"
  }
}

create_estimate_line_items

Add several lines to an estimate.

FieldTypeRequired
itemslist of objectyes
Example request body
{
  "input": {
    "items": [
      {
        "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
        "name": "name",
        "uom": "uom"
      }
    ]
  }
}

create_estimate_pricing_package

Add a pricing option to an estimate.

FieldTypeRequired
created_attext
descriptiontext
display_ordernumber
estimate_idtextyes
idtext
is_enabledtrue or false
nametext
tier_keytextyes
updated_attext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "tier_key": "tier key"
  }
}

create_estimate_section

Add a section to an estimate.

FieldTypeRequired
contentany
created_attext
display_ordernumber
estimate_idtextyes
idtext
is_visibletrue or false
section_typetextyes
show_titletrue or false
tiertext
titletext
updated_attext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "section_type": "section type"
  }
}

create_estimate_warranty_option

Add a warranty option to an estimate.

FieldTypeRequired
created_attext
descriptiontext
display_ordernumber
estimate_idtextyes
idtext
is_recommendedtrue or false
nametext
pricenumber
section_idtextyes
term_labeltext
updated_attext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "section_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_inspection

Start an inspection on a job.

FieldTypeRequired
answersany
damagetext
itemsanyyes
job_idtextyes
slope_countnumberyes
template_keytextyes
template_nametextyes
idtextyes
Example request body
{
  "input": {
    "items": "items",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "slope_count": 1,
    "template_key": "template key",
    "template_name": "template name",
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_invoice

Create an invoice.

FieldTypeRequired
idtext
job_idtext
contact_idtext
estimate_idtext
titletext
purposetext
issue_datetext
due_datetext
tax_ratenumber
discountobject
allow_partial_paymentstrue or false
minimum_paymentnumber
progress_group_idtext
progress_indexnumber
progress_countnumber
notestext
termstext
line_itemslist of objectyes
line_detailone of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only`
bill_toobject
show_claim_detailstrue or false
Example request body
{
  "input": {
    "line_items": [
      {
        "name": "name",
        "quantity": 1,
        "unit_price": 1250
      }
    ]
  }
}

create_invoice_schedule

Create a payment schedule of invoices.

FieldTypeRequired
group_idtext
job_idtext
contact_idtext
estimate_idtext
purposetext
issue_datetext
tax_ratenumber
allow_partial_paymentstrue or false
minimum_paymentnumber
notestext
termstext
line_detailone of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only`
bill_toobject
show_claim_detailstrue or false
partslist of objectyes
Example request body
{
  "input": {
    "parts": [
      {
        "index": 1,
        "count": 1,
        "title": "title",
        "due_date": "2026-11-19",
        "lines": [
          {
            "name": "name",
            "quantity": 1,
            "unit_price": 1250
          }
        ]
      }
    ]
  }
}

create_job

Create a job.

FieldTypeRequired
accepted_estimate_idtext
acv_amountnumber
adjuster_idtext
adjuster_meeting_attext
archive_kindtext
archivedtrue or false
assigned_totext
assignee_idslist of text
cancel_reasontext
canvasser_idtext
claim_approved_attext
claim_basistext
claim_denied_attext
claim_filed_attext
claim_numbertext
contract_datetext
contractor_idtext
cover_photo_urltext
custom_fieldsany
damage_typelist of text
date_of_losstext
deductiblenumber
dismissed_money_suggestionslist of text
estimated_amountnumber
final_amountnumber
financing_methodtext
homeowner_idtext
installation_datetext
insurance_companytext
job_nametextyes
job_typetext
lead_sourcetext
mortgage_companytext
nonrecoverable_depreciationnumber
pipeline_idtext
policy_numbertext
primary_contact_idtext
prioritytext
profit_marginnumber
project_manager_idtext
property_addresstextyes
property_citytext
property_countytext
property_statetext
property_typetext
property_ziptext
quick_summarytext
rcv_amountnumber
recoverable_depreciationnumber
roof_materialtext
roof_squaresnumber
secondary_adjusterslist of text
secondary_contactslist of text
shingle_manufacturertext
shingle_product_linetext
sold_bytext
stagetext
stage_entered_knowntrue or false
stage_move_ontext
stage_move_unknowntrue or false
storm_event_datetext
storm_event_detailsany
storm_event_idtext
submitted_amountnumber
supplements_amountnumber
tagslist of text
tradeslist of text
idtext
Example request body
{
  "input": {
    "job_name": "job name",
    "property_address": "property address"
  }
}

create_job_cost

Add a cost to a job.

FieldTypeRequired
amountnumber
categorytext
descriptiontext
file_idtext
idtext
incurred_ontext
job_idtextyes
vendortext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_job_document

Create a job document.

FieldTypeRequired
blocksany
doc_typetext
idtext
job_idtextyes
pdf_formany
render_enginetext
signature_field_defsany
signature_methodtext
signersany
template_idtext
titletextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "title": "title"
  }
}

create_job_file_record

Save a file or photo on a job.

FieldTypeRequired
added_viatext
categorytextyes
descriptiontext
file_pathtextyes
file_sizenumberyes
file_typetextyes
filenametextyes
inspection_idtext
inspection_steptext
job_idtextyes
latitudenumber
longitudenumber
mime_typetextyes
original_pathtext
tagslist of text
taken_attext
idtext
Example request body
{
  "input": {
    "category": "category",
    "file_path": "file path",
    "file_size": 1,
    "file_type": "file type",
    "filename": "filename",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "mime_type": "mime type"
  }
}

create_leaderboard_contest

Start a leaderboard contest.

FieldTypeRequired
idtext
titletextyes
metricone of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value`yes
starts_ontextyes
ends_ontextyes
prizetext
scopeone of `location`, `company`yes
Example request body
{
  "input": {
    "title": "title",
    "metric": "doors",
    "starts_on": "2026-11-19",
    "ends_on": "2026-11-19",
    "scope": "location"
  }
}

create_manual_measurement

Type in a job's roof measurements.

FieldTypeRequired
total_squaresnumber
total_area_sqftnumber
waste_factor_percentnumber
predominant_pitchtext
number_of_storiesnumber
ridge_length_lfnumber
hip_length_lfnumber
valley_length_lfnumber
eave_length_lfnumber
rake_length_lfnumber
drip_edge_lfnumber
flashing_lfnumber
step_flashing_lfnumber
penetrationsobject
pitch_breakdownlist of object
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_material_order

Create a material order.

FieldTypeRequired
job_idtext
estimate_idtext
supplier_idtext
source_tierone of `chosen`, `good`, `better`, `best`
delivery_datetext
delivery_addresstext
delivery_notestext
notestext
tax_ratenumber
additional_chargeslist of object
itemslist of objectyes
idtext
Example request body
{
  "input": {
    "items": [
      {
        "name": "name",
        "quantity": 1,
        "unit_cost": 1250
      }
    ]
  }
}

create_material_order_template

Create an order template.

FieldTypeRequired
nametextyes
notestext
supplier_idtext
itemslist of object
idtext
sold_productslist of text
Example request body
{
  "input": {
    "name": "name"
  }
}

create_note

Add a note to a job.

FieldTypeRequired
idtext
job_idtextyes
contenttextyes
created_attext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "content": "content"
  }
}

create_photo_comment

Comment on a photo.

FieldTypeRequired
bodytextyes
file_idtext
mentioned_user_idslist of text
pin_photo_idtext
Example request body
{
  "input": {
    "body": "body"
  }
}

Make a photo share link.

FieldTypeRequired
job_idtextyes
titletextyes
file_idslist of textyes
expires_attext
idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "title": "title",
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

create_photo_report_template

Save a photo report layout.

FieldTypeRequired
bodyanyyes
nametextyes
idtext
Example request body
{
  "input": {
    "body": "body",
    "name": "name"
  }
}

create_pin

Drop a pin on the map.

FieldTypeRequired
addresstext
citytext
created_attext
emailtext
homeowner_first_nametext
homeowner_last_nametext
homeowner_nametext
idtext
is_sharedtrue or false
job_idtext
knock_positionany
knock_resulttext
knock_result_optiontext
latitudenumberyes
longitudenumberyes
notestext
phonetext
pin_typetext
statetext
ziptext
Example request body
{
  "input": {
    "latitude": 1,
    "longitude": 1
  }
}

create_product

Add a product.

FieldTypeRequired
categorytext
costnumber
coverage_per_unitnumber
default_pricenumber
descriptiontext
idtext
is_activetrue or false
item_typeone of `regular`, `upgrade`
measurement_basistext
nametextyes
skutext
uomtext
waste_percentnumber
Example request body
{
  "input": {
    "name": "name"
  }
}

create_products

Add many products.

FieldTypeRequired
productslist of objectyes
Example request body
{
  "input": {
    "products": [
      {
        "name": "name"
      }
    ]
  }
}

create_products_skipping_taken_names

Add products, leaving out the ones already in the list.

FieldTypeRequired
productslist of objectyes
Example request body
{
  "input": {
    "products": [
      {
        "name": "name"
      }
    ]
  }
}

create_report

Save a report.

FieldTypeRequired
idtext
shareone of `me`, `location`, `company`yes
titletextyes
descriptiontext
foldertext
specobjectyes
viewobject
templateKeytext
pinnedtrue or false
Example request body
{
  "input": {
    "share": "me",
    "title": "title",
    "spec": {}
  }
}

create_sms_broadcast

Build a text broadcast.

FieldTypeRequired
nametext
bodytextyes
company_nametext
rep_nametext
rep_phonetext
scheduled_fortext
recipientslist of objectyes
idtext
from_phone_idtext
Example request body
{
  "input": {
    "body": "body",
    "recipients": [
      {
        "phone": "+16155550148",
        "opted_out": true
      }
    ]
  }
}

create_stage_tasks

Create the tasks a stage calls for.

FieldTypeRequired
job_idtextyes
new_stagetextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "new_stage": "new stage"
  }
}

create_supplier

Add a supplier.

FieldTypeRequired
account_numbertext
addresstext
contact_nametext
emailtext
idtext
is_activetrue or false
nametextyes
notestext
phonetext
Example request body
{
  "input": {
    "name": "name"
  }
}

create_task

Add a task.

FieldTypeRequired
adjuster_resulttext
appointment_optiontext
appointment_typetext
assigned_totext
attendee_idslist of text
calendar_event_idtext
calendar_idtext
completedtrue or false
completed_attext
contact_idtext
customer_remindertext
customer_reminder_sent_attext
descriptiontext
done_whentext
done_when_stagetext
due_datetext
duration_minutesnumber
end_datetext
followup_nudge_sent_attext
homeowner_messagestrue or false
idtext
job_idtext
locationtext
notification_idtext
outcometext
outcome_recorded_attext
prioritytext
reminder_minutesnumber
series_idtext
titletextyes
Example request body
{
  "input": {
    "title": "title"
  }
}

create_task_series

Make an event repeat.

FieldTypeRequired
series_idtextyes
starts_ontextyes
ruleobjectyes
templateobjectyes
adopt_task_idtext
Example request body
{
  "input": {
    "series_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "starts_on": "2026-11-19",
    "rule": {},
    "template": {}
  }
}

create_tasks

Add several tasks.

FieldTypeRequired
taskslist of objectyes
Example request body
{
  "input": {
    "tasks": [
      {
        "title": "title"
      }
    ]
  }
}

create_tracked_supplement

Log a supplement on a job.

FieldTypeRequired
amount_approvednumber
amount_requestednumber
closed_attext
job_idtextyes
layernumberyes
notestext
outcometext
sent_attext
statustext
idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "layer": 1
  }
}

create_work_order

Make a work order on a job.

FieldTypeRequired
arrival_timetext
auto_createdtrue or false
colorstext
crew_idtext
daysnumber
depends_ontext
hoa_statustext
homeowner_told_attext
job_idtextyes
material_order_idtext
materials_notestext
permit_statustext
photo_itemsany
positionnumber
required_shotslist of text
scopeany
scope_notetext
site_notestext
source_estimate_idtext
squaresnumber
start_datetext
statustext
sub_company_idtext
titletext
tradetext
tradeslist of text
idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

decide_work_order_issue

Approve or decline a problem the crew reported.

FieldTypeRequired
idtextyes
statusone of `approved`, `declined`, `open`yes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "status": "approved"
  }
}

detach_sender_from_contact

Take a phone number or email back off a contact.

FieldTypeRequired
contact_idtextyes
phonetext
emailtext (email)
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

dismiss_order_list_suggestion

Stop offering a change to an order list.

FieldTypeRequired
template_idtextyes
keytextyes
Example request body
{
  "input": {
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "key": "key"
  }
}

dismiss_photo_suggestions

Say no to the suggestions on photos.

FieldTypeRequired
file_idslist of textyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

dismiss_supplement_intake

Set an arrived carrier estimate aside.

FieldTypeRequired
intake_idtextyes
Example request body
{
  "input": {
    "intake_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

draft_material_order_from_measurements

Draft a material order from the roof's measurements.

FieldTypeRequired
job_idtextyes
template_idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

draft_supplement_rebuttal

Draft a rebuttal to the carrier.

FieldTypeRequired
case_idtextyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

drop_storm_list_pins

Drop a pin on every house in a storm list.

FieldTypeRequired
list_idtextyes
assign_to_user_idtext
Example request body
{
  "input": {
    "list_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

ensure_estimate_signer

Make sure a signer is on an estimate.

FieldTypeRequired
estimate_idtextyes
signer_emailtextyes
signer_nametextyes
signer_ordernumber
signer_roletext
idtext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signer_email": "dana@example.com",
    "signer_name": "signer name"
  }
}

Make a job QR sign link.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

estimate_storm_list

Count and price a storm list before building it.

FieldTypeRequired
nametextyes
rangeobjectyes
window_fromtextyes
window_totextyes
min_size_innumberyes
areaobjectyes
property_capwhole numberyes
dedupe_dayswhole number
assignee_idslist of textyes
colortextyes
Example request body
{
  "input": {
    "name": "name",
    "range": {
      "kind": "preset",
      "key": "key"
    },
    "window_from": "window from",
    "window_to": "window to",
    "min_size_in": 1,
    "area": {
      "kind": "territory",
      "territory_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
      "geojson": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              1
            ]
          ]
        ]
      }
    },
    "property_cap": 1,
    "assignee_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "color": "color"
  }
}

extract_carrier_scope

Read a carrier's estimate.

FieldTypeRequired
job_idtextyes
file_idtextyes
engine_modeone of `on`, `shadow`, `off`
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

extract_measurements

Read the measurements from an uploaded report.

FieldTypeRequired
job_idtextyes
file_idtextyes
source_typetextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "source_type": "source type"
  }
}

fetch_roof_picture_for_buildings

Get a satellite picture to tap a garage or shop on.

FieldTypeRequired
latitudenumberyes
longitudenumberyes
Example request body
{
  "input": {
    "latitude": -90,
    "longitude": -180
  }
}

fetch_roof_sketch_picture

Get the satellite picture to draw a roof on.

FieldTypeRequired
job_idtextyes
zoomnumber
centerobject
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

file_job_document_pdf

Save a document's PDF in the job's files.

FieldTypeRequired
kindone of `estimate`, `invoice`, `material_order`, `work_order`, `code_report`, `measurement_report`yes
record_idtextyes
job_idtext
document_numbertext
titletext
pdf_urltextyes
Example request body
{
  "input": {
    "kind": "estimate",
    "record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "pdf_url": "pdf url"
  }
}

find_or_create_contact_by_phone

Find or add a contact by phone number.

FieldTypeRequired
phonetextyes
Example request body
{
  "input": {
    "phone": "+16155550148"
  }
}

finish_import_run

Mark an import finished.

FieldTypeRequired
run_idtextyes
failedtrue or false
Example request body
{
  "input": {
    "run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

fit_estimate_to_roof

Bring an estimate up to the job's roof measurement and today's prices.

FieldTypeRequired
estimate_idtextyes
measurement_idtext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

forget_import_choices

Forget the choices kept from a system's imports.

FieldTypeRequired
sourceone of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate`yes
Example request body
{
  "input": {
    "source": "spreadsheet"
  }
}

generate_code_report_pdf

Make the PDF of the building code report.

FieldTypeRequired
job_idtextyes
manufacturertext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_customer_statement

Make a customer statement.

FieldTypeRequired
contact_idtext
job_idtext
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_invoice_pdf

Make the PDF of an invoice.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_job_document_pdf

Make the PDF of a job document.

FieldTypeRequired
document_idtextyes
Example request body
{
  "input": {
    "document_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_material_order_pdf

Make a material order's PDF.

FieldTypeRequired
order_idtextyes
include_pricingtrue or false
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_measurement_report_pdf

Make the PDF of a roof measurement report.

FieldTypeRequired
measurement_idtextyes
Example request body
{
  "input": {
    "measurement_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_photo_report

Make a photo report PDF.

FieldTypeRequired
job_idtextyes
specobject
file_idslist of text
share_with_homeownertrue or false
timeout_mswhole number
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_storm_report

Make a storm verification report.

FieldTypeRequired
job_idtext
pin_idtext
latitudenumber
longitudenumber
addresstext
citytext
statetext
ziptext
significant_datetext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

generate_work_order_pdf

Make the crew work order.

FieldTypeRequired
estimate_idtext
work_order_idtext
colourtext
crew_notestext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

get_companycam_status

See whether CompanyCam is connected.

It takes no input.

Example request body
{
  "input": {}
}

get_house_facts

Read a job's house: elevation, drone ceiling and storms.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

get_my_referral_code

Get this company's referral link.

It takes no input.

Example request body
{
  "input": {}
}

import_companycam_projects

Import CompanyCam projects as jobs.

FieldTypeRequired
project_idslist of text
itemslist of object
pipeline_idtext
stage_keytext
Example request body
{
  "input": {
    "project_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

import_contact_email_history

Bring in a contact's old emails.

FieldTypeRequired
contact_idtextyes
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

import_mailbox_email_history

Bring in recent email history.

It takes no input.

Example request body
{
  "input": {}
}

import_spreadsheet_rows

Import a batch of rows from a spreadsheet.

FieldTypeRequired
pipeline_idtextyes
rowslist of objectyes
run_idtext
sourceone of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate`
file_nametext
row_countwhole number
settingsobject
Example request body
{
  "input": {
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rows": [
      {}
    ]
  }
}

import_supplier_template

Import a template from the supplier's account.

FieldTypeRequired
template_idtextyes
nametext
Example request body
{
  "input": {
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

import_template_from_file

Read a file or pasted text into a template.

FieldTypeRequired
kindone of `estimate`, `products`, `document`, `inspection`yes
file_contenttext
file_mimetext
file_nametext
pdf_formone of `auto`, `never`, `always`
pasted_texttext
answerslist of object
Example request body
{
  "input": {
    "kind": "estimate"
  }
}

leave_appointment

Say you can't make an appointment.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Link a job to a CompanyCam project.

FieldTypeRequired
job_idtextyes
companycam_project_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "companycam_project_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Attach a contact to a text conversation.

FieldTypeRequired
sms_conversation_idtextyes
contact_idtextyes
Example request body
{
  "input": {
    "sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Attach an EagleView report you already have to a job.

FieldTypeRequired
job_idtextyes
report_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "report_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Attach a Hover report you already have to a job.

FieldTypeRequired
job_idtextyes
hover_job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "hover_job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Mark a storm list house as the pin it became.

FieldTypeRequired
property_idtextyes
pin_idtextyes
Example request body
{
  "input": {
    "property_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "pin_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

list_exportable_companycam_jobs

List the jobs that could be sent up to CompanyCam.

It takes no input.

Example request body
{
  "input": {}
}

list_google_calendars

List your Google calendars.

It takes no input.

Example request body
{
  "input": {}
}

list_importable_companycam_projects

List the CompanyCam projects that could be imported.

It takes no input.

Example request body
{
  "input": {}
}

look_up_property_owner

Look up who owns a house.

FieldTypeRequired
latitudenumberyes
longitudenumberyes
saved_onlytrue or false
Example request body
{
  "input": {
    "latitude": -90,
    "longitude": -180
  }
}

mark_all_notifications_read

Mark all notifications read.

It takes no input.

Example request body
{
  "input": {}
}

mark_email_conversation_handled

Mark an email conversation as read for the team.

FieldTypeRequired
thread_idtextyes
Example request body
{
  "input": {
    "thread_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_email_thread_read

Mark an email thread as read.

FieldTypeRequired
contact_idtext
contact_emailtext
owner_user_idtext
explicittrue or false
mailbox_idtext
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_inbox_thread_unread

Mark a conversation unread.

FieldTypeRequired
sms_conversation_idtext
contact_idtext
contact_emailtext
owner_user_idtext
Example request body
{
  "input": {
    "sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_invoice_sent

Mark an invoice sent.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_notification_read

Mark a notification read.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_notifications_read

Mark several notifications read.

FieldTypeRequired
notification_idslist of textyes
Example request body
{
  "input": {
    "notification_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

mark_sister_jobs_different

Say jobs in two sister companies are different jobs.

FieldTypeRequired
pairslist of objectyes
Example request body
{
  "input": {
    "pairs": [
      {
        "record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
        "other_record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ]
  }
}

mark_sms_conversation_read

Mark a text conversation read.

FieldTypeRequired
sms_conversation_idtextyes
explicittrue or false
Example request body
{
  "input": {
    "sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_supplement_sent

Record that the supplement package was sent.

FieldTypeRequired
case_idtextyes
submission_idtextyes
sent_tolist of textyes
cclist of textyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "submission_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "sent_to": [
      "sent to"
    ],
    "cc": [
      "cc"
    ]
  }
}

mark_supplement_tear_off_notified

Record that the carrier was told what the tear-off found.

FieldTypeRequired
case_idtextyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_support_replies_read

Mark support replies as seen.

FieldTypeRequired
request_idtextyes
Example request body
{
  "input": {
    "request_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

mark_work_order_materials_arrived

Mark the materials delivered at the job.

FieldTypeRequired
work_order_idtextyes
file_idtext
attext
Example request body
{
  "input": {
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

measure_roof_at_point

Measure the roof at a spot on the map.

FieldTypeRequired
latitudenumberyes
longitudenumberyes
addresstext
other_buildingtrue or false
Example request body
{
  "input": {
    "latitude": -90,
    "longitude": -180
  }
}

measure_roof_instantly

Measure a job's roof from the satellite.

FieldTypeRequired
job_idtextyes
reading_idtext
extra_reading_idslist of text
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

move_email_conversation

Move an email conversation to another location.

FieldTypeRequired
thread_idtextyes
to_workspace_idtextyes
Example request body
{
  "input": {
    "thread_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "to_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

move_job_past_open_tasks

Move a job on past its open tasks.

FieldTypeRequired
job_idtextyes
stagetextyes
reasontextyes
pipeline_idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage": "stage",
    "reason": "reason"
  }
}

move_job_to_stage

Move a job to a stage.

FieldTypeRequired
idtextyes
stagetextyes
pipeline_idtext
entered_attext
date_knowntrue or false
moved_ontext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage": "stage"
  }
}

move_photos_to_job

Move photos to another job.

FieldTypeRequired
file_idslist of textyes
job_idtextyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

pair_job_photos

Pair two photos as before and after.

FieldTypeRequired
before_idtextyes
after_idtextyes
pair_grouptextyes
Example request body
{
  "input": {
    "before_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "after_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "pair_group": "pair group"
  }
}

pause_sms_broadcast

Pause a text broadcast.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

peek_roof_reading

See the roof reading already kept for a spot.

FieldTypeRequired
latitudenumberyes
longitudenumberyes
addresstext
Example request body
{
  "input": {
    "latitude": -90,
    "longitude": -180
  }
}

prepare_rebuttal_attachments

Get the files a rebuttal goes out with.

FieldTypeRequired
job_idtextyes
package_file_idtextyes
bodytextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "package_file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "body": "body"
  }
}

preview_spreadsheet_import

Count what an import would make, change and leave alone.

FieldTypeRequired
rowslist of objectyes
sourceone of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate`
known_keyslist of text
Example request body
{
  "input": {
    "rows": [
      {}
    ]
  }
}

price_supplier_order_items

Get live supplier prices for an order.

FieldTypeRequired
material_order_idtextyes
ship_to_numbertextyes
branch_numbertextyes
Example request body
{
  "input": {
    "material_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "ship_to_number": "ship to number",
    "branch_number": "branch number"
  }
}

read_file_for_money

Read a file for a cost or payment.

FieldTypeRequired
file_idtextyes
Example request body
{
  "input": {
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

read_job_files_for_money

Read a job's waiting files for costs and payments.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

read_roof_facts_from_photos

Read a job's roof facts from its photos.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

record_supplement_outcomes

Record what the carrier said about each item.

FieldTypeRequired
case_idtextyes
submission_idtextyes
outcomeslist of objectyes
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "submission_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "outcomes": [
      {
        "rule_key": "rule key",
        "outcome": "approved",
        "amount_approved": 1250,
        "objection": "objection"
      }
    ]
  }
}

redraft_material_order

Redraft a material order with another template.

FieldTypeRequired
order_idtextyes
template_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

refile_communication

Move a message to another job.

FieldTypeRequired
idtextyes
job_idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

refresh_measurement_orders

Check on the roof measurement orders.

FieldTypeRequired
job_idtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remember_supplier_item_mappings

Remember supplier item numbers.

FieldTypeRequired
providertextyes
mappingslist of objectyes
Example request body
{
  "input": {
    "provider": "provider",
    "mappings": [
      {
        "match_key": "match key",
        "match_kind": "product",
        "supplier_item_number": "supplier item number",
        "supplier_description": "supplier description",
        "uom": "uom"
      }
    ]
  }
}

remove_analytics_alert

Turn off an alert on a number.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_analytics_chart

Take a chart off the charts in Reports.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_job_checklist_item_photo

Take a photo off an item on a job's checklist (it stays in the job's photos).

FieldTypeRequired
item_idtextyes
file_idtextyes
Example request body
{
  "input": {
    "item_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_job_tags

Take tags off several jobs.

FieldTypeRequired
idslist of textyes
tagslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "tags": [
      "tag"
    ]
  }
}

remove_showcase_photos

Take photos off the showcase page.

FieldTypeRequired
file_idslist of textyes
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

remove_work_order_shot

Take a photo off one of a work order's required shots.

FieldTypeRequired
work_order_idtextyes
shottextyes
file_idtextyes
Example request body
{
  "input": {
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "shot": "shot",
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Make a new link to a work order's crew sheet.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

reorder_estimate_rows

Put an estimate's sections, lines or options in a new order.

FieldTypeRequired
tableone of `estimate_sections`, `estimate_line_items`, `estimate_photos`, `estimate_pricing_packages`, `estimate_warranty_options`yes
idslist of textyes
Example request body
{
  "input": {
    "table": "estimate_sections",
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

reorder_estimate_signers

Change the signing order.

FieldTypeRequired
estimate_idtextyes
ordered_idslist of textyes
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "ordered_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

replace_job_document_signers

Set who signs a job document.

FieldTypeRequired
document_idtextyes
signerslist of objectyes
Example request body
{
  "input": {
    "document_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signers": [
      {
        "signer_name": "signer name",
        "signer_email": "dana@example.com",
        "signer_role": "signer role",
        "signer_order": -9007199254740991
      }
    ]
  }
}

replace_material_order_items

Replace a material order's lines.

FieldTypeRequired
order_idtextyes
itemslist of objectyes
tax_ratenumber
additional_chargeslist of object
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "items": [
      {
        "name": "name",
        "quantity": 1,
        "unit_cost": 1250
      }
    ]
  }
}

replace_material_order_template_items

Replace an order template's rules.

FieldTypeRequired
template_idtextyes
itemslist of objectyes
Example request body
{
  "input": {
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "items": [
      {
        "name": "name"
      }
    ]
  }
}

report_code_answer

Say a code answer is wrong.

FieldTypeRequired
job_idtextyes
fieldtextyes
answerone of `yes`, `no`yes
notetext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "field": "field",
    "answer": "yes"
  }
}

report_work_order_issue

Report a problem found on the job (rotten decking, more damage).

FieldTypeRequired
file_idslist of text
notetextyes
quantitynumber
unittext
work_order_idtextyes
idtext
Example request body
{
  "input": {
    "note": "note",
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

request_job_access

Ask to be added to a job.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

request_work_order_materials

Ask the office for more materials, or to return leftovers.

FieldTypeRequired
work_order_idtextyes
kindone of `addon`, `return`yes
lineslist of objectyes
notetext
idtextyes
Example request body
{
  "input": {
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "kind": "addon",
    "lines": [
      {
        "name": "name",
        "quantity": 1
      }
    ],
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

restore_deleted_contact

Put a deleted contact back.

FieldTypeRequired
contact_idtextyes
Example request body
{
  "input": {
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

restore_deleted_job

Put a deleted job back.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

restore_deleted_media

Put a deleted photo or file back.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

restore_deleted_record

Put back a deleted note, estimate, contract, task, invoice, payment or pin.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

restore_jobs

Put several jobs back how they were.

FieldTypeRequired
jobslist of objectyes
Example request body
{
  "input": {
    "jobs": [
      {
        "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ]
  }
}

retry_failed_sister_sync

Try the failed sister company sends again.

FieldTypeRequired
source_workspace_idtextyes
target_workspace_idtextyes
Example request body
{
  "input": {
    "source_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "target_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

review_knock_check

Mark a flagged knock checked.

FieldTypeRequired
knock_idtextyes
reviewedtrue or falseyes
Example request body
{
  "input": {
    "knock_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "reviewed": true
  }
}

run_export_now

Make an export file now.

FieldTypeRequired
schedule_idtext
nametext
itemslist of object
formatone of `xlsx`, `csv`, `json`
delivertrue or false
wait_secondswhole number
Example request body
{
  "input": {
    "schedule_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

run_supplement_review

Run the supplement review for a job.

FieldTypeRequired
job_idtextyes
carrier_scope_idtext
sourcetext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

save_analytics_alert

Set an alert on a number.

FieldTypeRequired
idtext
specobjectyes
conditionone of `above`, `below`, `up_by`, `down_by`, `report`yes
thresholdnumberyes
cadenceone of `daily`, `weekly`yes
activetrue or falseyes
Example request body
{
  "input": {
    "spec": {},
    "condition": "above",
    "threshold": 0,
    "cadence": "daily",
    "active": true
  }
}

save_analytics_page

Save the charts in Reports in their new order.

FieldTypeRequired
teamtrue or falseyes
cardslist of objectyes
Example request body
{
  "input": {
    "team": false,
    "cards": [
      {
        "spec": {},
        "size": "half",
        "origin": "person"
      }
    ]
  }
}

save_email_draft

Save an email draft.

FieldTypeRequired
attachmentsany
bcc_emailslist of text
bodytext
cc_emailslist of text
contact_idtext
idtext
in_reply_totext
job_idtext
quoted_message_idtext
reply_modetext
subjecttext
thread_idtext
to_emailslist of text
Example request body
{
  "input": {
    "attachments": "attachments"
  }
}

save_invoice_edits

Change an invoice's details and lines.

FieldTypeRequired
idtextyes
job_idtext
contact_idtext
estimate_idtext
titletext
purposetext
issue_datetext
due_datetext
tax_ratenumber
discountobject
allow_partial_paymentstrue or false
minimum_paymentnumber
notestext
termstext
line_detailone of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only`
bill_toone of `customer`, `insurance`, `mortgage`, `other`
bill_to_nametext
bill_to_emailtext
bill_to_referencetext
show_claim_detailstrue or false
line_itemslist of objectyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "line_items": [
      {
        "name": "name",
        "quantity": 1,
        "unit_price": 1250
      }
    ]
  }
}

save_invoice_internal_note

Save an invoice's private note.

FieldTypeRequired
idtextyes
notetextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "note": "note"
  }
}

save_note_mentions

Save who a note mentions.

FieldTypeRequired
note_idtextyes
job_idtextyes
mentioned_user_idslist of textyes
Example request body
{
  "input": {
    "note_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "mentioned_user_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

save_roof_facts

Record what a person knows about a roof.

FieldTypeRequired
job_idtextyes
factslist of objectyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "facts": [
      {
        "key": "total_squares",
        "value": "value"
      }
    ]
  }
}

save_roof_picture

Save the roof's satellite picture on its measurement.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

save_roof_sketch

Save a roof drawing as the job's measurement.

FieldTypeRequired
job_idtextyes
existingobjectyes
fieldsobjectyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "existing": {
      "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
      "source_type": "source type",
      "status": "status"
    },
    "fields": {
      "total_area_sqft": 1250,
      "total_squares": 1250,
      "predominant_pitch": "predominant pitch",
      "pitch_breakdown": [
        {
          "pitch": "pitch",
          "area_sqft": 1,
          "percent_of_roof": 1
        }
      ],
      "facets": [
        {
          "label": "label",
          "area_sqft": 1,
          "pitch": "pitch",
          "type": "flat"
        }
      ],
      "ridge_length_lf": 1,
      "hip_length_lf": 1,
      "valley_length_lf": 1,
      "eave_length_lf": 1,
      "rake_length_lf": 1,
      "step_flashing_lf": 1,
      "flashing_lf": 1,
      "drip_edge_lf": 1,
      "waste_factor_percent": 1,
      "raw_extraction": "raw extraction"
    }
  }
}

search_companycam_import_jobs

Find a job to add a CompanyCam project to.

FieldTypeRequired
querytextyes
Example request body
{
  "input": {
    "query": "query"
  }
}

search_companycam_projects

Search the company's CompanyCam projects.

FieldTypeRequired
job_idtextyes
querytext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_crew_lead

Make somebody a crew's lead.

FieldTypeRequired
crew_idtextyes
user_idtextyes
Example request body
{
  "input": {
    "crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_default_email_signature

Make an email signature the automatic one.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_default_material_order_template

Set the default order template.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_estimate_photo_caption

Change a photo caption on an estimate.

FieldTypeRequired
idtextyes
captiontextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "caption": "caption"
  }
}

set_estimate_photo_in_pdf

Include or leave out a photo in the estimate PDF.

FieldTypeRequired
idtextyes
include_in_pdftrue or falseyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "include_in_pdf": true
  }
}

set_estimate_status

Move an estimate to another status.

FieldTypeRequired
statustext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_file_money_suggestion_dismissed

Say no to a cost or payment found in a file (or take it back).

FieldTypeRequired
file_idtextyes
dismissedtrue or falseyes
Example request body
{
  "input": {
    "file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "dismissed": true
  }
}

set_job_site_guest_uploads

Turn guest photos on a job sign on or off.

FieldTypeRequired
link_idtextyes
ontrue or falseyes
Example request body
{
  "input": {
    "link_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "on": true
  }
}

set_materials_not_needed

Say a sold job needs no material order, or take it back.

FieldTypeRequired
job_idtextyes
not_neededtrue or falseyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "not_needed": true
  }
}

set_measurement_report_source

Say whose report a roof measurement was read from.

FieldTypeRequired
idtextyes
source_typeone of `eagleview`, `hover`, `roofr`, `gaf`, `other`yes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "source_type": "eagleview"
  }
}

set_measurement_waste_factor

Change a roof measurement's waste factor.

FieldTypeRequired
idtextyes
waste_percentnumberyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "waste_percent": 0
  }
}

set_my_language

Choose the language of my crew screens.

FieldTypeRequired
languageone of `en`, `es`yes
Example request body
{
  "input": {
    "language": "en"
  }
}

Turn a photo share link off (or back on).

FieldTypeRequired
idtextyes
turned_offtrue or falseyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "turned_off": true
  }
}

set_photo_report_shared

Show a photo report on the homeowner page (or stop).

FieldTypeRequired
idtextyes
share_with_homeownertrue or falseyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "share_with_homeowner": true
  }
}

set_photo_tags

Tag several photos at once.

FieldTypeRequired
updateslist of objectyes
Example request body
{
  "input": {
    "updates": [
      {
        "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
        "tags": [
          "tag"
        ]
      }
    ]
  }
}

set_pin_photo_caption

Change a pin photo's caption.

FieldTypeRequired
idtextyes
captiontextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "caption": "caption"
  }
}

set_pin_photo_tags

Change a pin photo's tags.

FieldTypeRequired
idtextyes
tagslist of textyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "tags": [
      "tag"
    ]
  }
}

Mark the recommended warranty option.

FieldTypeRequired
estimate_idtextyes
option_idtextyes
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "option_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_site_photos_default

Set whether new job signs take photos from anyone.

FieldTypeRequired
ontrue or falseyes
Example request body
{
  "input": {
    "on": true
  }
}

set_work_order_pay

Set a work order's crew pay, or mark it paid.

FieldTypeRequired
work_order_idtextyes
amountnumber
paid_attext (date-time)
lineslist of object
Example request body
{
  "input": {
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

shift_work_orders

Move builds for a rain day.

FieldTypeRequired
daytextyes
crew_idslist of textyes
bywhole numberyes
Example request body
{
  "input": {
    "day": "2026-11-19",
    "crew_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "by": -30
  }
}

snooze_notifications

Snooze notifications.

FieldTypeRequired
notification_idslist of textyes
untiltextyes
Example request body
{
  "input": {
    "notification_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "until": "until"
  }
}

stage_import_rows

Hand over the rows of an import.

FieldTypeRequired
run_idtextyes
pipeline_idtextyes
rowslist of objectyes
offsetwhole numberyes
sourceone of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate`
file_nametext
row_countwhole numberyes
settingsobject
Example request body
{
  "input": {
    "run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rows": [
      {}
    ],
    "offset": 0,
    "row_count": 0
  }
}

start_estimate

Start an estimate: good, better, best, one price, itemized, insurance or repair.

FieldTypeRequired
starterone of `good_better_best`, `one_price`, `itemized`, `insurance`, `repair`yes
idtext
job_idtext
titletext
saved_option_idslist of text
carrier_scope_idtext
measurement_idtext
as_templatetrue or false
Example request body
{
  "input": {
    "starter": "good_better_best"
  }
}

start_import_run

Start an import in the background.

FieldTypeRequired
run_idtextyes
Example request body
{
  "input": {
    "run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

step_work_order

Say a work order started or finished.

FieldTypeRequired
idtextyes
stepone of `started`, `finished`, `undo_started`, `undo_finished`, `accepted`, `on_way`yes
attext (date-time)
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "step": "started"
  }
}

sync_companycam_job

Sync a job's photos with CompanyCam now.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

sync_roof_facts_from_job

Fold a job's shingle maker and product into its roof facts.

FieldTypeRequired
job_idtextyes
shingle_manufacturertextyes
shingle_product_linetextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "shingle_manufacturer": "shingle manufacturer",
    "shingle_product_line": "shingle product line"
  }
}

sync_supplier_favorites

Remember the items this company buys from the supplier.

FieldTypeRequired
bill_to_numbertextyes
branch_numbertext
Example request body
{
  "input": {
    "bill_to_number": "bill to number"
  }
}

take_back_material_order_approval

Take back a material order's approval.

FieldTypeRequired
order_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

undo_invoice_sent

Take back an invoice send that never went out.

FieldTypeRequired
invoice_idtextyes
sent_attextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "sent_at": "2026-11-19T15:00:00Z"
  }
}

undo_photo_suggestions

Take back the suggested captions and tags on photos.

FieldTypeRequired
file_idslist of textyes
beforeobject
Example request body
{
  "input": {
    "file_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

Stop syncing a job with CompanyCam.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

unpair_job_photos

Take two photos out of a before and after pair.

FieldTypeRequired
pair_grouptextyes
Example request body
{
  "input": {
    "pair_group": "pair group"
  }
}

unsnooze_notifications

Bring snoozed notifications back.

FieldTypeRequired
notification_idslist of textyes
Example request body
{
  "input": {
    "notification_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

update_analytics_chart

Change a chart in Reports.

FieldTypeRequired
idtextyes
titletext
specobject
sizeone of `half`, `full`
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_communication_log

Change a logged email, text or call.

FieldTypeRequired
ai_draftedtrue or false
ai_summarytext
bodytext
body_htmltext
call_durationnumber
call_routeany
call_statustext
cc_emailslist of text
contact_idtext
delivered_attext
delivery_errortext
directiontext
estimate_idtext
external_message_idtext
from_emailtext
idtextyes
in_reply_totext
invoice_idtext
job_idtext
media_urlslist of text
message_idtext
opened_attext
phone_number_idtext
read_attext
recipienttext
recipient_nametext
recording_pathtext
sent_attext
sms_conversation_idtext
statustext
subjecttext
supplement_submission_idtext
thread_idtext
to_emailslist of text
typetext
user_email_account_idtext
waveform_peakslist of number
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_contact

Change a contact's details.

FieldTypeRequired
additional_phonesany
addresstext
adjuster_extensiontext
adjuster_typetext
assigned_totext
citytext
claim_numbertext
companytext
custom_fieldsany
emailtext
first_nametext
gate_codetext
idtextyes
languagetext
last_nametext
notestext
phonetext
phone_labeltext
sms_consenttrue or false
sms_consent_attext
sms_consent_methodtext
statetext
tradeslist of text
typetext
ziptext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_contacts

Change several contacts.

FieldTypeRequired
idslist of textyes
changesobjectyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "changes": {
      "address": "address"
    }
  }
}

update_crew_document

Change when a crew's paper runs out.

FieldTypeRequired
expires_ontext
kindtext
labeltext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_eagleview_order_address

Fix the address on an EagleView order.

FieldTypeRequired
order_idtextyes
addresstextyes
citytextyes
statetextyes
ziptextyes
latitudenumber
longitudenumber
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "address": "address",
    "city": "city",
    "state": "state",
    "zip": "zip"
  }
}

update_email_signature

Change an email signature.

FieldTypeRequired
idtextyes
nametextyes
bodytextyes
is_defaulttrue or falseyes
formatone of `text`, `designed`, `html`
designany
htmltext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "name": "name",
    "body": "body",
    "is_default": true
  }
}

update_email_template

Change an email template.

FieldTypeRequired
bodytext
is_sharedtrue or false
nametext
subjecttext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate

Change an estimate.

FieldTypeRequired
allow_multiple_optionstrue or false
approval_statustext
approved_marginnumber
best_includes_bettertrue or false
best_package_descriptiontext
best_package_enabledtrue or false
best_package_nametext
better_package_descriptiontext
better_package_enabledtrue or false
better_package_nametext
certification_idslist of text
change_order_basenumber
cover_company_addresstext
cover_company_emailtext
cover_company_logo_urltext
cover_company_nametext
cover_company_phonetext
cover_homeowner_greetingtext
cover_intro_texttext
cover_layouttext
cover_logo_scalenumber
cover_photo_focus_xnumber
cover_photo_focus_ynumber
cover_property_photo_urltext
created_attext
default_margin_percentnumber
document_typetext
estimate_numbertext
expires_attext
good_package_descriptiontext
good_package_enabledtrue or false
good_package_nametext
idtextyes
import_file_idtext
import_sourcetext
is_proposaltrue or false
is_sampletrue or false
is_templatetrue or false
job_idtext
lost_reasontext
lost_reason_notetext
notestext
package_discountsany
package_price_overridesany
package_ratesany
packages_are_standalonetrue or false
parent_estimate_idtext
profitability_typetext
proposal_cover_titletext
proposal_footer_texttext
render_enginetext
roof_squaresnumber
round_quantitiestrue or false
scope_headingtext
selected_option_keyslist of text
selected_tiertext
selected_upgrade_idslist of text
selected_warranty_option_idtext
show_line_item_pricestrue or false
show_line_item_quantitiestrue or false
show_line_item_totalstrue or false
show_line_item_unit_pricetrue or false
show_line_item_uomtrue or false
signature_field_defsany
signature_methodtext
signature_page_numbernumber
signer_emailtext
signer_nametext
signing_order_enabledtrue or false
statustext
tax_ratenumber
terms_and_conditionstext
titletext
updated_attext
valid_untiltext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate_line_item

Change a line of an estimate.

FieldTypeRequired
base_quantitynumber
created_attext
descriptiontext
display_ordernumber
idtextyes
is_optionaltrue or false
margin_linkedtrue or false
material_costnumber
measurement_fieldtext
measurement_idtext
nametext
product_idtext
profit_amountnumber
profit_margin_percentnumber
quantitynumber
section_idtext
tiertext
unit_pricenumber
uomtext
updated_attext
waste_percentnumber
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate_line_items

Re-price several lines of an estimate.

FieldTypeRequired
changeslist of objectyes
Example request body
{
  "input": {
    "changes": [
      {
        "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ]
  }
}

update_estimate_pricing_package

Change a pricing option on an estimate.

FieldTypeRequired
descriptiontext
display_ordernumber
is_enabledtrue or false
nametext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate_section

Change a section of an estimate.

FieldTypeRequired
contentany
created_attext
display_ordernumber
idtextyes
is_visibletrue or false
section_typetext
show_titletrue or false
tiertext
titletext
updated_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate_signer

Change a signer on an estimate.

FieldTypeRequired
signer_emailtext
signer_nametext
signer_ordernumber
signer_roletext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_estimate_warranty_option

Change a warranty option on an estimate.

FieldTypeRequired
descriptiontext
display_ordernumber
is_recommendedtrue or false
nametext
pricenumber
term_labeltext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_inspection

Change an inspection.

FieldTypeRequired
answersany
damagetext
itemsany
slope_countnumber
statustext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_invoice

Change an invoice.

FieldTypeRequired
allow_partial_paymentstrue or false
autopaytrue or false
autopay_method_idtext
due_datetext
financing_pendingtrue or false
late_fee_exempttrue or false
reminders_pausedtrue or false
statustext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job

Change a job.

FieldTypeRequired
accepted_estimate_idtext
acv_amountnumber
adjuster_idtext
adjuster_meeting_attext
archive_kindtext
archivedtrue or false
assigned_totext
assignee_idslist of text
cancel_reasontext
canvasser_idtext
claim_approved_attext
claim_basistext
claim_denied_attext
claim_filed_attext
claim_numbertext
contract_datetext
contractor_idtext
cover_photo_urltext
custom_fieldsany
damage_typelist of text
date_of_losstext
deductiblenumber
dismissed_money_suggestionslist of text
estimated_amountnumber
final_amountnumber
financing_methodtext
homeowner_idtext
installation_datetext
insurance_companytext
job_nametext
job_typetext
lead_sourcetext
lost_reasontext
mortgage_companytext
nonrecoverable_depreciationnumber
pipeline_idtext
policy_numbertext
primary_contact_idtext
prioritytext
profit_marginnumber
project_manager_idtext
property_addresstext
property_citytext
property_countytext
property_statetext
property_typetext
property_ziptext
quick_summarytext
rcv_amountnumber
recoverable_depreciationnumber
roof_materialtext
roof_squaresnumber
secondary_adjusterslist of text
secondary_contactslist of text
shingle_manufacturertext
shingle_product_linetext
sold_bytext
stagetext
stage_entered_attext
stage_entered_knowntrue or false
stage_move_ontext
stage_move_unknowntrue or false
storm_event_datetext
storm_event_detailsany
storm_event_idtext
submitted_amountnumber
supplements_amountnumber
tagslist of text
tradeslist of text
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job_checklist

Rename a job's checklist, link it to a company checklist, or take it off the job.

FieldTypeRequired
nametext
removed_attext
template_idtext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job_checklist_item

Tick or change an item on a job's checklist.

FieldTypeRequired
headingtext
labeltext
notetext
photo_file_idtext
positionnumber
quantitynumber
statustext
status_attext
unittext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job_cost

Change a job cost.

FieldTypeRequired
amountnumber
categorytext
descriptiontext
file_idtext
idtextyes
incurred_ontext
job_idtext
updated_attext
vendortext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job_document

Change a job document.

FieldTypeRequired
blocksany
doc_typetext
idtextyes
job_idtext
pdf_formany
render_enginetext
signature_field_defsany
signature_methodtext
signersany
statustext
template_idtext
titletext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_job_file

Rename, tag or caption a file or photo.

FieldTypeRequired
categorytext
descriptiontext
filenametext
tagslist of text
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_jobs

Change several jobs.

FieldTypeRequired
idslist of textyes
changesobjectyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "changes": {
      "accepted_estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    }
  }
}

update_leaderboard_contest

Change a leaderboard contest.

FieldTypeRequired
idtextyes
titletext
metricone of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value`
starts_ontext
ends_ontext
prizetext
scopeone of `location`, `company`
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_material_order

Change a material order.

FieldTypeRequired
additional_chargesany
delivered_attext
delivery_addresstext
delivery_address_line1text
delivery_address_line2text
delivery_citytext
delivery_contact_nametext
delivery_contact_phonetext
delivery_datetext
delivery_notestext
delivery_postaltext
delivery_statetext
estimate_idtext
idtextyes
job_idtext
kindtext
notestext
parent_order_idtext
source_tiertext
statustext
supplier_idtext
takeoff_asked_attext
tax_ratenumber
template_idtext
updated_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_material_order_item_supplier_data

Apply a supplier's item numbers and prices to an order.

FieldTypeRequired
order_idtextyes
updateslist of objectyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "updates": [
      {
        "item_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ]
  }
}

update_material_order_template

Change an order template.

FieldTypeRequired
nametext
notestext
sold_productslist of text
supplier_idtext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_measurement

Change a job's roof measurements.

FieldTypeRequired
total_squaresnumber
total_area_sqftnumber
waste_factor_percentnumber
predominant_pitchtext
number_of_storiesnumber
ridge_length_lfnumber
hip_length_lfnumber
valley_length_lfnumber
eave_length_lfnumber
rake_length_lfnumber
drip_edge_lfnumber
flashing_lfnumber
step_flashing_lfnumber
penetrationsobject
pitch_breakdownlist of object
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_note

Change a note.

FieldTypeRequired
idtextyes
contenttext
job_idtext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_pin

Change a pin.

FieldTypeRequired
addresstext
citytext
emailtext
homeowner_first_nametext
homeowner_last_nametext
homeowner_nametext
idtextyes
is_sharedtrue or false
job_idtext
knock_positionany
knock_resulttext
knock_result_optiontext
latitudenumber
longitudenumber
notestext
phonetext
pin_typetext
statetext
ziptext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_product

Change a product.

FieldTypeRequired
categorytext
costnumber
coverage_per_unitnumber
default_pricenumber
descriptiontext
idtextyes
is_activetrue or false
item_typeone of `regular`, `upgrade`
measurement_basistext
nametext
skutext
uomtext
updated_attext
waste_percentnumber
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_punch_item

Tick off (or reword) a punch list item.

FieldTypeRequired
idtextyes
texttext
done_attext (date-time)
file_idslist of text
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_report

Change a saved report.

FieldTypeRequired
idtextyes
titletext
descriptiontext
foldertext
specobject
viewobject
shareone of `me`, `location`, `company`
pinnedtrue or false
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_storm_list

Rename, recolour, reassign or archive a storm list.

FieldTypeRequired
idtextyes
nametext
colortext
assignee_idslist of text
archived_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_supplement_case

Change a supplement case.

FieldTypeRequired
assigned_totext
autopilottrue or false
depreciation_deadlinetext
next_actiontext
next_action_attext
stagetext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_supplement_gap

Change an item in a supplement.

FieldTypeRequired
evidence_file_idslist of text
includedtrue or false
notetext
override_qtynumber
override_unit_pricenumber
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_supplement_submission

Change a supplement.

FieldTypeRequired
amount_approvednumber
amount_requestednumber
carrier_response_rawtext
carrier_scope_idtext
case_idtext
case_versionnumber
cclist of text
closed_attext
email_message_idtext
email_thread_idtext
followup_countnumber
idtextyes
job_idtext
layernumber
letter_file_idtext
letter_texttext
next_followup_attext
notestext
opened_attext
outcometext
package_file_idtext
replied_attext
sent_attext
sent_tolist of text
shingle_manufacturertext
shingle_product_linetext
sourcetext
statustext
supplement_itemsany
total_itemsnumber
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_supplier

Change a supplier.

FieldTypeRequired
account_numbertext
addresstext
contact_nametext
emailtext
idtextyes
is_activetrue or false
nametext
notestext
phonetext
updated_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_task

Change a task.

FieldTypeRequired
adjuster_resulttext
appointment_optiontext
appointment_typetext
assigned_totext
attendee_idslist of text
calendar_event_idtext
calendar_idtext
completedtrue or false
completed_attext
contact_idtext
customer_remindertext
customer_reminder_sent_attext
descriptiontext
done_whentext
done_when_stagetext
due_datetext
duration_minutesnumber
end_datetext
followup_nudge_sent_attext
homeowner_messagestrue or false
idtextyes
job_idtext
locationtext
notification_idtext
outcometext
outcome_recorded_attext
prioritytext
reminder_minutesnumber
series_idtext
titletext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_task_series

Change this and the following repeats.

FieldTypeRequired
series_idtextyes
from_task_idtextyes
changesobjectyes
Example request body
{
  "input": {
    "series_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "from_task_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "changes": {}
  }
}

update_tasks

Change several tasks.

FieldTypeRequired
idslist of textyes
changesobjectyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "changes": {
      "adjuster_result": "adjuster result"
    }
  }
}

update_work_order

Change a work order (crew, day, scope).

FieldTypeRequired
arrival_timetext
auto_createdtrue or false
colorstext
crew_idtext
daysnumber
depends_ontext
hoa_statustext
homeowner_told_attext
material_order_idtext
materials_notestext
permit_statustext
photo_itemsany
positionnumber
required_shotslist of text
scopeany
scope_notetext
site_notestext
source_estimate_idtext
squaresnumber
start_datetext
statustext
sub_company_idtext
titletext
tradetext
tradeslist of text
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Money

accrue_job_commission

Work out the commission on a job.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

answer_eagleview_report_type_change

Approve or decline EagleView's change of report type.

FieldTypeRequired
order_idtextyes
approvetrue or falseyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "approve": true
  }
}

cancel_eagleview_order

Cancel an EagleView order.

FieldTypeRequired
order_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

cancel_hover_order

Cancel a Hover capture request.

FieldTypeRequired
order_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

charge_saved_payment_method

Charge a saved card.

FieldTypeRequired
invoice_idtextyes
saved_method_idtextyes
amount_centsnumber
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "saved_method_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_commission

Add a commission to a job.

FieldTypeRequired
amountnumber
basistextyes
basis_amountnumber
company_cut_percentnumber
earned_sharenumber
flat_amountnumber
idtext
installmentnumber
job_idtextyes
notetext
owed_whentext
rate_percentnumberyes
roletext
user_idtextyes
Example request body
{
  "input": {
    "basis": "basis",
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rate_percent": 1,
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_payment

Record a payment.

FieldTypeRequired
amountnumberyes
check_numbertext
date_depositedtext
date_receivedtext
date_sent_to_mortgagetext
file_idtext
idtext
import_idtext
invoice_idtext
is_sampletrue or false
job_idtext
notestext
payer_typetext
payment_methodtext
payment_typetextyes
processortext
processor_feenumber
processor_referencetext
statustext
Example request body
{
  "input": {
    "amount": 1250,
    "payment_type": "payment type"
  }
}

keep_payments_waiting

Keep a file’s unplaced payments waiting for a person.

FieldTypeRequired
processortextyes
rowslist of objectyes
Example request body
{
  "input": {
    "processor": "processor",
    "rows": [
      {
        "processor_reference": "processor reference",
        "kind": "payment",
        "amount": 1250,
        "date_received": "2026-11-19"
      }
    ]
  }
}

mark_commissions_paid

Mark commissions paid.

FieldTypeRequired
commission_idslist of textyes
Example request body
{
  "input": {
    "commission_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

match_material_order_bill

Match the supplier's bill to a material order.

FieldTypeRequired
order_idtextyes
amountnumberyes
invoice_numbertext
file_idtext
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "amount": 1250
  }
}

pay_commissions

Pay a person's commissions.

FieldTypeRequired
user_idtextyes
commission_idslist of textyes
notetext
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "commission_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

record_base_pay

Record base pay.

FieldTypeRequired
user_idtextyes
amountnumberyes
period_starttextyes
period_endtextyes
counts_as_drawtrue or falseyes
occurred_ontextyes
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "amount": 1250,
    "period_start": "period start",
    "period_end": "period end",
    "counts_as_draw": true,
    "occurred_on": "2026-11-19"
  }
}

record_commission_draw

Record a draw.

FieldTypeRequired
user_idtextyes
amountnumberyes
occurred_ontextyes
notetextyes
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "amount": 1250,
    "occurred_on": "2026-11-19",
    "note": "note"
  }
}

record_imported_payments

Record a batch of imported payments.

FieldTypeRequired
import_idtextyes
paymentslist of objectyes
refundslist of objectyes
Example request body
{
  "input": {
    "import_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "payments": [],
    "refunds": []
  }
}

record_payments

Record a check split across payments.

FieldTypeRequired
paymentslist of objectyes
Example request body
{
  "input": {
    "payments": [
      {
        "amount": 1250,
        "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
        "payment_type": "payment type"
      }
    ]
  }
}

record_processor_payment

Record a payment taken through another processor.

FieldTypeRequired
processortextyes
referencetextyes
amountnumberyes
kindone of `payment`, `refund`yes
original_referencetext
datetext
feenumber
methodone of `card`, `ach`, `check`, `cash`, `financing`, `other`
depositedtrue or false
invoice_idtext
invoice_numbertext
job_idtext
job_numbertext
customer_nametext
customer_emailtext
customer_phonetext
descriptiontext
notestext
Example request body
{
  "input": {
    "processor": "processor",
    "reference": "reference",
    "amount": 1250,
    "kind": "payment"
  }
}

refund_payment

Refund a payment.

FieldTypeRequired
payment_idtextyes
amountnumberyes
notestext
datetextyes
Example request body
{
  "input": {
    "payment_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "amount": 1250,
    "date": "2026-11-19"
  }
}

release_mortgage_draw

Release part of a mortgage check.

FieldTypeRequired
payment_idtextyes
amountnumberyes
date_receivedtextyes
draw_idtextyes
Example request body
{
  "input": {
    "payment_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "amount": 1250,
    "date_received": "2026-11-19",
    "draw_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

save_commission_pay_settings

Save a person's base pay.

FieldTypeRequired
user_idtextyes
base_pay_weeklynumberyes
base_pay_starts_ontextyes
base_pay_is_drawtrue or falseyes
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "base_pay_weekly": 1,
    "base_pay_starts_on": "2026-11-19",
    "base_pay_is_draw": true
  }
}

set_incoming_payments_aside

Set payments another app sent aside, or bring them back.

FieldTypeRequired
idslist of textyes
asidetrue or falseyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "aside": true
  }
}

set_record_status

Change the status of an estimate, invoice, contract, order or payment.

FieldTypeRequired
kindone of `estimate`, `invoice`, `material_order`, `smartdoc`, `payment`yes
idtextyes
statustextyes
Example request body
{
  "input": {
    "kind": "estimate",
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "status": "status"
  }
}

start_payment_import

Start importing payments from a processor’s file.

FieldTypeRequired
idtextyes
processortextyes
file_nametext
line_countwhole numberyes
skipped_countwhole number
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "processor": "processor",
    "line_count": 0
  }
}

submit_supplier_order

Place an order with the supplier.

FieldTypeRequired
material_order_idtextyes
ship_to_numbertextyes
ship_to_nametext
branch_numbertextyes
delivery_servicetext
delivery_date_tbdtrue or false
Example request body
{
  "input": {
    "material_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "ship_to_number": "ship to number",
    "branch_number": "branch number"
  }
}

sync_invoice_to_quickbooks

Send an invoice to QuickBooks.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

sync_quickbooks_record

Send a record to QuickBooks.

FieldTypeRequired
entity_typeone of `payment`, `estimate`, `contact`, `job_cost`, `material_order`, `commission_ledger`yes
entity_idtextyes
Example request body
{
  "input": {
    "entity_type": "payment",
    "entity_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

undo_invoice_write_off

Undo an invoice write-off.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_owed_commission

Change an owed commission.

FieldTypeRequired
amountnumber
basistext
basis_amountnumber
company_cut_percentnumber
earned_sharenumber
flat_amountnumber
idtextyes
installmentnumber
job_idtext
notetext
owed_whentext
rate_percentnumber
roletext
updated_attext
user_idtext
statusone of `owed`, `void`
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_payment

Change a payment.

FieldTypeRequired
amountnumber
check_numbertext
date_depositedtext
date_receivedtext
date_sent_to_mortgagetext
file_idtext
idtextyes
import_idtext
invoice_idtext
is_sampletrue or false
job_idtext
notestext
payer_typetext
payment_methodtext
payment_typetext
processortext
processor_feenumber
processor_referencetext
statustext
updated_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

waive_invoice_late_fee

Waive the late fee on an invoice.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

write_off_invoice

Write off an invoice.

FieldTypeRequired
invoice_idtextyes
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Sending

ask_supplier_for_takeoff

Ask the supplier to build a material order from the measurement report.

FieldTypeRequired
order_idtextyes
custom_messagetext
subjecttext
bodytext
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Cancel a homeowner's signing link.

FieldTypeRequired
kindone of `job_document`, `estimate`yes
idtextyes
Example request body
{
  "input": {
    "kind": "job_document",
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

create_companycam_project

Make a CompanyCam project for a job.

FieldTypeRequired
job_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

export_jobs_to_companycam

Make a CompanyCam project for each picked job.

FieldTypeRequired
job_idslist of textyes
Example request body
{
  "input": {
    "job_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

move_jobs_to_stage

Move several jobs to a stage.

FieldTypeRequired
idslist of textyes
stagetextyes
pipeline_idtext
date_knowntrue or false
moved_ontext
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "stage": "stage"
  }
}

queue_stage_followups

Queue a stage rule's later messages.

FieldTypeRequired
job_idtextyes
contact_idtextyes
rule_idtextyes
stage_keytextyes
nowtext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rule_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage_key": "stage key"
  }
}

reply_to_support_request

Write back on a support conversation.

FieldTypeRequired
request_idtextyes
messagetextyes
screentext
platformtext
app_versiontext
posthog_session_idtext
Example request body
{
  "input": {
    "request_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "message": "message"
  }
}

request_crew_papers

Ask a crew or a sub company for its papers by text.

FieldTypeRequired
crew_idtext
sub_company_idtext
kindslist of one of `insurance`, `workers_comp`, `w9`, `license`, `other`yes
notetext
bodytext
from_phone_idtext
Example request body
{
  "input": {
    "kinds": [
      "insurance"
    ]
  }
}

request_estimate_signature

Send an estimate to be signed.

FieldTypeRequired
estimate_idtextyes
signer_emailtextyes
signer_nametextyes
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signer_email": "dana@example.com",
    "signer_name": "signer name"
  }
}

Set up signing by link.

FieldTypeRequired
estimate_idtextyes
signerslist of objectyes
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signers": [
      {
        "name": "name",
        "email": "dana@example.com",
        "order": 1
      }
    ]
  }
}

resend_hover_capture

Send the homeowner Hover's capture request again.

FieldTypeRequired
order_idtextyes
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

resume_sms_broadcast

Resume a paused text broadcast.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

run_stage_change_automation

Send a job's stage-change message.

FieldTypeRequired
job_idtextyes
new_stagetextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "new_stage": "new stage"
  }
}

schedule_email

Schedule an email to send later.

FieldTypeRequired
contact_idtext
job_idtext
send_attextyes
payloadobjectyes
Example request body
{
  "input": {
    "send_at": "2026-11-19T15:00:00Z",
    "payload": {
      "to": [
        "to"
      ],
      "subject": "subject",
      "body": "body"
    }
  }
}

schedule_text

Schedule a text to send later.

FieldTypeRequired
idtextyes
contact_idtext
job_idtext
to_phonetextyes
bodytextyes
media_urlslist of text
send_attextyes
from_phone_idtext
kindone of `payment`, `portal`, `appointment`, `crew`, `review`, `broadcast`, `conversation`, `quote`, `follow_up`
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "to_phone": "+16155550148",
    "body": "body",
    "send_at": "2026-11-19T15:00:00Z"
  }
}

Text the HailMate app link to a phone.

FieldTypeRequired
phonetextyes
workspace_idtext
Example request body
{
  "input": {
    "phone": "+16155550148"
  }
}

send_crew_invite

Text a crew person their invite.

FieldTypeRequired
invite_idtextyes
bodytext
from_phone_idtext
Example request body
{
  "input": {
    "invite_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_email

Send an email.

FieldTypeRequired
tolist of textyes
cclist of text
bcclist of text
subjecttextyes
bodytextyes
body_formatone of `markdown`, `text`
quoted_texttext
quoted_htmltext
signature_texttext
signature_htmltext
contact_idtext
job_idtext
estimate_idtext
invoice_idtext
supplement_submission_idtext
in_reply_totext
thread_idtext
ai_draftedtrue or false
send_asone of `mailbox`, `workspace`
copy_selftrue or false
attachmentslist of object
Example request body
{
  "input": {
    "to": [
      "to"
    ],
    "subject": "subject",
    "body": "body"
  }
}

send_estimate_email

Email an estimate.

FieldTypeRequired
estimate_idtextyes
recipient_emailtextyes
recipient_nametext
custom_messagetext
Example request body
{
  "input": {
    "estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "recipient_email": "dana@example.com"
  }
}

send_held_message_anyway

Send a held text or email anyway.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_invoice

Email an invoice.

FieldTypeRequired
invoice_idtextyes
totextyes
subjecttext
custom_messagetext
bodytext
attachment_nametext
Example request body
{
  "input": {
    "invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "to": "to"
  }
}

send_invoice_reminders

Send invoice reminders.

FieldTypeRequired
invoice_idslist of textyes
from_phone_idtext
Example request body
{
  "input": {
    "invoice_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

send_job_document_for_signature

Send a job document for signature.

FieldTypeRequired
document_idtextyes
signing_methodone of `in_person`, `email`yes
signerslist of objectyes
messagetext
sign_firsttrue or false
Example request body
{
  "input": {
    "document_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "signing_method": "in_person",
    "signers": [
      {
        "name": "name",
        "email": "dana@example.com",
        "order": -9007199254740991
      }
    ]
  }
}

send_jobs_to_sister_workspace

Send several jobs to a sister company.

FieldTypeRequired
record_idslist of textyes
target_workspace_idtextyes
travelobject
Example request body
{
  "input": {
    "record_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "target_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_material_order_to_supplier

Email a material order to the supplier.

FieldTypeRequired
order_idtextyes
custom_messagetext
include_pricingtrue or false
subjecttext
bodytext
attach_csvtrue or false
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_payment_receipt

Email a payment receipt.

FieldTypeRequired
payment_idtextyes
Example request body
{
  "input": {
    "payment_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_queued_message_now

Send a scheduled text now.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_review_request

Text a customer a review request.

FieldTypeRequired
job_idtextyes
new_stagetext
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_sms_message

Send a text.

FieldTypeRequired
contact_idtext
contact_phonetextyes
bodytextyes
job_idtext
ai_draftedtrue or false
media_urlslist of text
from_phone_idtext
kindone of `payment`, `portal`, `appointment`, `crew`, `review`, `broadcast`, `conversation`, `quote`, `follow_up`
Example request body
{
  "input": {
    "contact_phone": "+16155550148",
    "body": "body"
  }
}

send_supplement_rebuttal

Send the rebuttal to the carrier.

FieldTypeRequired
case_idtextyes
bodytext
Example request body
{
  "input": {
    "case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_to_sister_workspace

Send a contact or job to a sister company.

FieldTypeRequired
kindone of `contact`, `job`yes
record_idtextyes
target_workspace_idtextyes
travelobject
Example request body
{
  "input": {
    "kind": "contact",
    "record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "target_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

send_work_order_message

Write on a work order's chat with the crew.

FieldTypeRequired
idtextyes
work_order_idtextyes
bodytextyes
file_idslist of text
languageone of `en`, `es`
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "body": ""
  }
}

start_sms_broadcast

Send a text broadcast.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

submit_support_request

Ask HailMate support for help.

FieldTypeRequired
workspace_idtext
messagetextyes
help_chat_idtext
screentext
platformtext
app_versiontext
posthog_session_idtext
Example request body
{
  "input": {
    "message": "message"
  }
}

tell_supplier_delivery_change

Email the supplier a new delivery day.

FieldTypeRequired
order_idtextyes
delivery_datetextyes
subjecttext
bodytext
reasonone of `rain`
Example request body
{
  "input": {
    "order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "delivery_date": "2026-11-19"
  }
}

Setup

add_certification

Add a certification from the catalog.

FieldTypeRequired
certification_program_idtextyes
credential_numbertext
custom_logo_urltext
display_ordernumber
Example request body
{
  "input": {
    "certification_program_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

add_custom_certification

Add a certification of your own.

FieldTypeRequired
organizationtext
programtextyes
badge_labeltext
credential_numbertext
custom_logo_urltext
display_ordernumber
Example request body
{
  "input": {
    "program": "program"
  }
}

add_state_territory

Add a state to the territory.

FieldTypeRequired
labeltextyes
state_codetextyes
Example request body
{
  "input": {
    "label": "label",
    "state_code": "state code"
  }
}

apply_commission_setup

Choose how the company pays people.

FieldTypeRequired
setupone of `reps_do_it_all`, `setters_and_closers`, `hourly_setters`yes
owed_whenone of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid`yes
salesobjectyes
canvasserobjectyes
Example request body
{
  "input": {
    "setup": "reps_do_it_all",
    "owed_when": "contract_signed",
    "sales": {
      "basis": "job_value",
      "rate_percent": 0,
      "flat_amount": 1250,
      "owed_when": "contract_signed"
    },
    "canvasser": {
      "basis": "job_value",
      "rate_percent": 0,
      "flat_amount": 1250,
      "owed_when": "contract_signed"
    }
  }
}

archive_inspection_template

Hide a photo checklist.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

change_crew_invite_phone

Change an invited crew person's cell.

FieldTypeRequired
invite_idtextyes
phonetextyes
Example request body
{
  "input": {
    "invite_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "phone": "+16155550148"
  }
}

change_crew_login_phone

Move a crew login to a new cell.

FieldTypeRequired
user_idtextyes
phonetextyes
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "phone": "+16155550148"
  }
}

complete_companycam_setup

Finish setting up CompanyCam.

It takes no input.

Example request body
{
  "input": {}
}

create_boldsign_sender_identity

Set up the address contracts are sent from.

It takes no input.

Example request body
{
  "input": {}
}

create_calendar

Add a calendar.

FieldTypeRequired
auto_join_roleslist of text
colortext
default_for_typeslist of text
members_see_alltrue or false
nametextyes
idtext
member_idslist of textyes
Example request body
{
  "input": {
    "name": "name",
    "member_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

create_crew

Add a crew.

FieldTypeRequired
activetrue or false
colortext
contact_idtext
emailtext
kindtext
nametextyes
notestext
phonetext
squares_per_daynumber
sub_company_idtext
tradeslist of text
idtext
member_idslist of text
lead_idtext
Example request body
{
  "input": {
    "name": "name"
  }
}

create_document_template

Create a document template.

FieldTypeRequired
blocksany
descriptiontext
doc_typetext
idtext
nametextyes
pdf_formany
Example request body
{
  "input": {
    "name": "name"
  }
}

create_export_schedule

Email a report or export on a schedule.

FieldTypeRequired
nametextyes
itemslist of objectyes
formatone of `xlsx`, `csv`yes
cadenceone of `day`, `week`, `month`yes
weekdaywhole number
month_daywhole number
hourwhole numberyes
time_zonetext
deliver_memberslist of text
deliver_emailslist of text (email)
destination_idtext
Example request body
{
  "input": {
    "name": "name",
    "items": [
      {
        "saved_report_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
      }
    ],
    "format": "xlsx",
    "cadence": "day",
    "hour": 0
  }
}

Make a website lead link.

FieldTypeRequired
assigned_totext
kindtext
lead_sourcetext
nametextyes
pipeline_idtext
stage_keytext
idtext
Example request body
{
  "input": {
    "name": "name"
  }
}

create_pipeline

Add a pipeline.

FieldTypeRequired
descriptiontext
display_ordernumber
idtext
nametextyes
slugtextyes
visibilitytext
visible_roleslist of text
Example request body
{
  "input": {
    "name": "name",
    "slug": "slug"
  }
}

create_pipeline_stage

Add a stage to a pipeline.

FieldTypeRequired
colortext
display_ordernumber
hidden_from_roleslist of text
hold_until_tasks_donetrue or false
idtext
is_completedtrue or false
is_losttrue or false
labeltextyes
milestonetext
pipeline_idtextyes
stage_keytextyes
stage_people_staytrue or false
Example request body
{
  "input": {
    "label": "label",
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage_key": "stage key"
  }
}

create_rep_territory

Draw a rep territory.

FieldTypeRequired
nametextyes
colortextyes
ringlist of objectyes
assignee_idslist of textyes
Example request body
{
  "input": {
    "name": "name",
    "color": "color",
    "ring": [
      {
        "latitude": -90,
        "longitude": -180
      }
    ],
    "assignee_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

create_saved_pricing_package

Save a pricing package.

FieldTypeRequired
descriptiontext
display_ordernumber
idtext
itemsany
nametextyes
price_per_squarenumber
starter_keytext
Example request body
{
  "input": {
    "name": "name"
  }
}

create_sub_company

Add a subcontractor company.

FieldTypeRequired
activetrue or false
languagetext
nametextyes
notestext
owner_nametext
owner_phonetext
idtext
Example request body
{
  "input": {
    "name": "name"
  }
}

create_workflow

Create an automation.

FieldTypeRequired
actionsanyyes
conditionsanyyes
descriptiontextyes
enabledtrue or falseyes
idtext
nametextyes
triggeranyyes
Example request body
{
  "input": {
    "actions": "actions",
    "conditions": "conditions",
    "description": "description",
    "enabled": true,
    "name": "name",
    "trigger": "trigger"
  }
}

decide_crew_join_request

Answer a helper who asked to be put on a crew.

FieldTypeRequired
idtextyes
crew_idtextyes
is_leadtrue or falseyes
languageone of `en`, `es`yes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "is_lead": false,
    "language": "en"
  }
}

disconnect_companycam

Disconnect CompanyCam.

It takes no input.

Example request body
{
  "input": {}
}

dismiss_imported_person

Dismiss an imported person.

FieldTypeRequired
person_idtextyes
Example request body
{
  "input": {
    "person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

give_imported_jobs

Give imported jobs to a teammate.

FieldTypeRequired
person_idtextyes
user_idtextyes
limitwhole numberyes
Example request body
{
  "input": {
    "person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "limit": 100
  }
}

Link an imported person to a teammate by email.

FieldTypeRequired
person_idtextyes
emailtextyes
Example request body
{
  "input": {
    "person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "email": "dana@example.com"
  }
}

Link a job to the same job in a sister company.

FieldTypeRequired
record_idtextyes
target_record_idtextyes
choicesobject
Example request body
{
  "input": {
    "record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "target_record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

refresh_stage_people_jobs

Bring a column's jobs in line with who works it.

FieldTypeRequired
stage_idtextyes
Example request body
{
  "input": {
    "stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_leaderboard_goal

Take a leaderboard goal away.

FieldTypeRequired
metricone of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value`yes
Example request body
{
  "input": {
    "metric": "doors"
  }
}

rename_company_document

Rename a company document.

FieldTypeRequired
idslist of textyes
nametextyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "name": "name"
  }
}

Give a website lead link a new address.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Give the showcase page a new address.

FieldTypeRequired
share_tokentext
Example request body
{
  "input": {
    "share_token": "share token"
  }
}

reorder_calendars

Put the calendars in a new order.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

reorder_pipeline_stages

Put a pipeline's stages in a new order.

FieldTypeRequired
stageslist of objectyes
Example request body
{
  "input": {
    "stages": [
      {
        "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
        "display_order": -9007199254740991
      }
    ]
  }
}

replace_commission_rates

Change the rates on a commission plan.

FieldTypeRequired
rule_idtext
setter_rule_idtext
rateslist of objectyes
Example request body
{
  "input": {
    "rates": [
      {
        "lead_source": "lead source",
        "job_type": "insurance",
        "rate_percent": 1
      }
    ]
  }
}

reset_message_template

Put an automatic message back to the standard wording.

FieldTypeRequired
template_keytextyes
Example request body
{
  "input": {
    "template_key": "template key"
  }
}

resolve_job_access_request

Add someone to a job, or not now.

FieldTypeRequired
request_idtextyes
addtrue or falseyes
Example request body
{
  "input": {
    "request_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "add": true
  }
}

Turn off a live link.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

save_checklist_template

Save a company checklist.

FieldTypeRequired
idtext
nametextyes
itemslist of objectyes
auto_add_stage_idslist of textyes
required_stage_idslist of text
starter_keytext
positionwhole number
Example request body
{
  "input": {
    "name": "name",
    "items": [
      {}
    ],
    "auto_add_stage_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

save_commission_rule

Save a commission plan.

FieldTypeRequired
user_idtextyes
rate_percentnumberyes
flat_amountnumberyes
basistextyes
is_activetrue or falseyes
company_cut_percentnumber
owed_whenone of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid`
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rate_percent": 1,
    "flat_amount": 1250,
    "basis": "basis",
    "is_active": true
  }
}

save_commission_setter_rule

Save a setter commission plan.

FieldTypeRequired
user_idtextyes
rate_percentnumberyes
flat_amountnumberyes
basistextyes
is_activetrue or falseyes
company_cut_percentnumber
owed_whenone of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid`
Example request body
{
  "input": {
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "rate_percent": 1,
    "flat_amount": 1250,
    "basis": "basis",
    "is_active": true
  }
}

save_commission_settings

Choose when commissions are owed.

FieldTypeRequired
owed_whenone of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid`yes
setupone of `reps_do_it_all`, `setters_and_closers`, `hourly_setters`
Example request body
{
  "input": {
    "owed_when": "contract_signed"
  }
}

save_crew_invite

Add a person to a crew by name and cell.

FieldTypeRequired
kindone of `member`, `sub_owner`yes
crew_idtext
sub_company_idtext
nametextyes
phonetextyes
is_leadtrue or falseyes
languageone of `en`, `es`yes
work_order_idtext
Example request body
{
  "input": {
    "kind": "member",
    "name": "name",
    "phone": "+16155550148",
    "is_lead": false,
    "language": "en"
  }
}

save_crew_rate

Set a line on a crew's rate card.

FieldTypeRequired
idtext
crew_idtextyes
labeltextyes
unitone of `sq`, `steep_sq`, `layer_sq`, `each`, `lf`, `sheet`, `day`, `hour`, `job`yes
ratenumberyes
positionwhole number
Example request body
{
  "input": {
    "crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "label": "label",
    "unit": "sq",
    "rate": 0
  }
}

save_estimate_settings

Save the estimate defaults.

FieldTypeRequired
auto_draft_estimatestrue or false
boldsign_synced_nametext
company_insurance_infotext
company_license_numbertext
default_cost_per_squarenumber
default_labor_cost_per_squarenumber
default_material_cost_per_squarenumber
default_price_per_squarenumber
default_tax_ratenumber
default_templatesany
default_terms_and_conditionstext
default_valid_daysnumber
deposit_percentnumber
extra_layer_per_squarenumber
extra_story_per_squarenumber
invoice_default_due_daysnumber
invoice_default_notestext
invoice_default_tax_ratenumber
invoice_default_termstext
min_margin_percentnumber
pdf_primary_colortext
steep_pitch_fromnumber
steep_pitch_per_squarenumber
Example request body
{
  "input": {
    "auto_draft_estimates": true
  }
}

save_inspection_template

Save a photo checklist.

FieldTypeRequired
idtext
nametextyes
descriptiontext
itemslist of objectyes
ruleslist of text
based_ontext
Example request body
{
  "input": {
    "name": "name",
    "items": [
      {}
    ]
  }
}

save_job_role_settings

Choose which roles the company uses on its jobs.

FieldTypeRequired
canvasser_ontrue or false
project_manager_ontrue or false
Example request body
{
  "input": {
    "canvasser_on": true
  }
}

save_leaderboard_goal

Set a leaderboard goal.

FieldTypeRequired
metricone of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value`yes
perone of `day`, `week`, `month`yes
targetnumberyes
Example request body
{
  "input": {
    "metric": "doors",
    "per": "day",
    "target": 1
  }
}

save_location_settings

Change the team map settings.

FieldTypeRequired
team_maptrue or false
knock_check_feetwhole number
Example request body
{
  "input": {
    "team_map": true
  }
}

save_message_template

Save the wording of an automatic message.

FieldTypeRequired
template_keytextyes
subjecttext
bodytext
enabledtrue or false
Example request body
{
  "input": {
    "template_key": "template key"
  }
}

save_money_targets

Set the company's monthly goals and overhead.

FieldTypeRequired
monthly_collected_goalnumberyes
monthly_sold_goalnumberyes
monthly_overheadnumberyes
Example request body
{
  "input": {
    "monthly_collected_goal": 0,
    "monthly_sold_goal": 0,
    "monthly_overhead": 0
  }
}

save_payment_import_profile

Remember how a processor’s file is read.

FieldTypeRequired
header_signaturetextyes
processortextyes
mappingobjectyes
defaultsobject
Example request body
{
  "input": {
    "header_signature": "header signature",
    "processor": "processor",
    "mapping": {}
  }
}

save_showcase_settings

Change the showcase page.

FieldTypeRequired
publishedtrue or false
headlinetext
introtext
Example request body
{
  "input": {
    "published": true
  }
}

save_workspace_automation

Save an automation setting.

FieldTypeRequired
typeone of `stage_change`, `missed_call_text_back`, `invoice_overdue`, `review_request`, `stage_task`, `job_timer`, `appointment`yes
enabledtrue or falseyes
configobjectyes
managed_keyslist of text
Example request body
{
  "input": {
    "type": "stage_change",
    "enabled": true,
    "config": {}
  }
}

set_appointment_length

Set how long a kind of appointment takes.

FieldTypeRequired
appointment_typeone of `appointment`, `adjuster_meeting`, `inspection`, `build_day`yes
duration_minuteswhole numberyes
Example request body
{
  "input": {
    "appointment_type": "appointment",
    "duration_minutes": 15
  }
}

set_calendar_members

Choose who is on a calendar.

FieldTypeRequired
idtextyes
member_idslist of textyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "member_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

set_checklist_template_required

Require a company checklist to be finished before a job moves on from a stage, or stop requiring it.

FieldTypeRequired
template_idtextyes
stage_idtextyes
ontrue or falseyes
Example request body
{
  "input": {
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "on": true
  }
}

set_checklist_template_stage

Add a company checklist at a stage, or stop adding it there.

FieldTypeRequired
template_idtextyes
stage_idtextyes
ontrue or falseyes
Example request body
{
  "input": {
    "template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "on": true
  }
}

set_default_pipeline

Make a pipeline the company's main one.

FieldTypeRequired
pipeline_idtextyes
Example request body
{
  "input": {
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_default_stage

Choose the stage new jobs start in.

FieldTypeRequired
pipeline_idtextyes
stage_idtextyes
Example request body
{
  "input": {
    "pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_job_setter

Choose who set a job.

FieldTypeRequired
job_idtextyes
user_idtextyes
Example request body
{
  "input": {
    "job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

set_rep_territory_archived

Archive or restore a rep territory.

FieldTypeRequired
idtextyes
archivedtrue or falseyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "archived": true
  }
}

set_stage_people

Choose who works a column.

FieldTypeRequired
stage_idtextyes
user_idslist of textyes
Example request body
{
  "input": {
    "stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

set_stages_hidden_from_roles

Hide the jobs in some stages from some team roles.

FieldTypeRequired
stage_idslist of textyes
roleslist of textyes
Example request body
{
  "input": {
    "stage_ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ],
    "roles": [
      "role"
    ]
  }
}

set_workflow_enabled

Switch an automation on or off.

FieldTypeRequired
idtextyes
enabledtrue or falseyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "enabled": true
  }
}

start_companycam_connection

Start connecting CompanyCam.

It takes no input.

Example request body
{
  "input": {}
}

switch_state_territory

Change a state in the territory.

FieldTypeRequired
territory_idtextyes
state_codetextyes
applytrue or falseyes
Example request body
{
  "input": {
    "territory_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "state_code": "state code",
    "apply": true
  }
}

sync_boldsign_brand

Send the company's logo and color to BoldSign.

It takes no input.

Example request body
{
  "input": {}
}

Stop sharing a contact or job with sister companies.

FieldTypeRequired
kindone of `contact`, `job`yes
record_idtextyes
Example request body
{
  "input": {
    "kind": "contact",
    "record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_calendar

Change a calendar.

FieldTypeRequired
auto_join_roleslist of text
colortext
default_for_typeslist of text
members_see_alltrue or false
nametext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_certification

Change a certification.

FieldTypeRequired
idtextyes
credential_numbertext
custom_logo_urltext
display_ordernumber
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_companycam_settings

Change the CompanyCam sync settings.

FieldTypeRequired
settingsobjectyes
Example request body
{
  "input": {
    "settings": {
      "photo_sync": "pull",
      "auto_create_projects": true,
      "auto_link_projects": true,
      "sync_tags": true,
      "auto_create_jobs": true
    }
  }
}

update_crew

Change a crew.

FieldTypeRequired
activetrue or false
colortext
contact_idtext
emailtext
kindtext
nametext
notestext
phonetext
squares_per_daynumber
sub_company_idtext
tradeslist of text
idtextyes
member_idslist of text
lead_idtext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_document_template

Change a document template.

FieldTypeRequired
blocksany
descriptiontext
doc_typetext
idtextyes
nametext
pdf_formany
updated_attext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_export_schedule

Change a scheduled export.

FieldTypeRequired
idtextyes
nametext
itemslist of object
formatone of `xlsx`, `csv`
cadenceone of `day`, `week`, `month`
weekdaywhole number
month_daywhole number
hourwhole number
time_zonetext
deliver_memberslist of text
deliver_emailslist of text (email)
destination_idtext
pausedtrue or false
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Change a website lead link.

FieldTypeRequired
assigned_totext
enabledtrue or false
kindtext
lead_sourcetext
nametext
pipeline_idtext
price_pagetrue or false
stage_keytext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_pipeline

Change a pipeline.

FieldTypeRequired
descriptiontext
display_ordernumber
nametext
slugtext
visibilitytext
visible_roleslist of text
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_pipeline_stage

Change a stage.

FieldTypeRequired
colortext
display_ordernumber
hidden_from_roleslist of text
hold_until_tasks_donetrue or false
is_completedtrue or false
is_losttrue or false
labeltext
milestonetext
stage_keytext
stage_people_staytrue or false
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_quickbooks_sync_settings

Read or change the QuickBooks sync switches.

FieldTypeRequired
auto_pushtrue or false
pull_paymentstrue or false
map_productstrue or false
Example request body
{
  "input": {
    "auto_push": true
  }
}

update_rep_territory

Change a rep territory.

FieldTypeRequired
idtextyes
nametext
colortext
ringlist of object
assignee_idslist of text
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_saved_pricing_package

Change a saved pricing package.

FieldTypeRequired
descriptiontext
display_ordernumber
itemsany
nametext
price_per_squarenumber
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_sub_company

Change a subcontractor company.

FieldTypeRequired
activetrue or false
languagetext
nametext
notestext
owner_nametext
owner_phonetext
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_voicemail_settings

Change your voicemail greeting.

FieldTypeRequired
phone_idtextyes
enabledtrue or false
greeting_texttext
max_length_secondswhole number
Example request body
{
  "input": {
    "phone_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

update_workflow

Change an automation.

FieldTypeRequired
actionsany
conditionsany
descriptiontext
enabledtrue or false
nametext
triggerany
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Deleting

cancel_crew_invite

Cancel a crew invite.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_calendar

Delete a calendar.

FieldTypeRequired
idtextyes
move_totext
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_carrier_scope

Delete a carrier's estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_checklist_template

Delete a company checklist.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_commission_rule

Delete a commission plan.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_commission_setter_rule

Delete a setter commission plan.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_communication_log

Delete a logged email, text or call.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_company_document

Delete a company document.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

delete_contact

Delete a contact.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_contacts

Delete several contacts.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

delete_crew

Remove a crew.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_document_template

Delete a document template.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_email_draft

Delete an email draft.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_email_signature

Delete an email signature.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_email_template

Delete an email template.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimate

Delete an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimate_line_item

Delete a line of an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimate_pricing_package

Remove a pricing option from an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimate_section

Delete a section of an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimate_warranty_option

Remove a warranty option from an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_estimates

Delete several estimates.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

delete_export_schedule

Stop a scheduled export.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_inspection

Delete an inspection.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_invoice

Delete an invoice.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_job

Delete a job.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_job_checklist_item

Take an item off a job's checklist.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_job_cost

Delete a job cost.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_job_document

Delete a job document.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_job_documents

Delete several job documents.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

delete_job_file

Delete a file or photo.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_jobs

Delete several jobs.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

Delete a website lead link.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_leaderboard_contest

Delete a leaderboard contest.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_material_order

Delete a material order.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_material_order_template

Delete an order template.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_measurement

Delete a job's roof measurement.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_note

Delete a note.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_notification

Delete a notification.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_payment

Delete a payment.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_photo_comment

Delete a photo comment.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

Delete a photo share link.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_photo_report_template

Delete a photo report layout.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_pin

Delete a pin.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_pin_photo

Delete a pin photo.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_pipeline

Delete a pipeline.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_pipeline_stage

Delete a stage.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_product

Delete a product.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_read_notifications

Clear all read notifications.

It takes no input.

Example request body
{
  "input": {}
}

delete_rep_territory

Delete a rep territory.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_report

Delete a saved report.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_saved_pricing_package

Delete a saved pricing package.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_scheduled_email

Clear a cancelled or failed scheduled email.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_sms_broadcast

Delete a draft text broadcast.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_storm_list

Delete a storm list.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_supplement_hand_item

Remove an item added by hand.

FieldTypeRequired
gap_idtextyes
Example request body
{
  "input": {
    "gap_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_supplement_submission

Delete a supplement.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_supplier

Delete a supplier.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_task

Delete a task.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_tasks

Delete several tasks.

FieldTypeRequired
idslist of textyes
Example request body
{
  "input": {
    "ids": [
      "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
    ]
  }
}

delete_territory

Remove a state from the territory.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_work_order

Delete a work order.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

delete_workflow

Delete an automation.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

end_task_series

Delete this and the following repeats.

FieldTypeRequired
series_idtextyes
from_task_idtextyes
aftertrue or false
Example request body
{
  "input": {
    "series_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "from_task_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

forget_supplier_item_mapping

Forget a remembered supplier item number.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

purge_deleted_media

Delete a photo or file for good.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_certification

Remove a certification.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_commission_ledger_entry

Take back a draw or base pay entry.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_crew_day_off

Take a crew's day off back.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_crew_document

Remove a crew's paper.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_crew_person

Take somebody off a crew.

FieldTypeRequired
crew_idtextyes
user_idtextyes
Example request body
{
  "input": {
    "crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
    "user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_crew_rate

Take a line off a crew's rate card.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_estimate_photo

Remove a photo or document from an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_estimate_signer

Remove a signer from an estimate.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_job_person

Take someone off a job.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_punch_item

Take an item off a punch list.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_sample_job

Take the sample job off.

It takes no input.

Example request body
{
  "input": {}
}

remove_sub_company

Remove a subcontractor company.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

remove_work_order_log

Remove a daily log entry.

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

reset_inspection_template

Delete a photo checklist (or put back HailMate's).

FieldTypeRequired
idtextyes
Example request body
{
  "input": {
    "id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

undo_import_run

Undo an import.

FieldTypeRequired
run_idtextyes
Example request body
{
  "input": {
    "run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}

undo_payment_import

Undo a payment import.

FieldTypeRequired
import_idtextyes
Example request body
{
  "input": {
    "import_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
  }
}