On this page
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).
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.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
{
"input": {
"file_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}add_analytics_chart
Add a chart to the charts in Reports.
| Field | Type | Required |
|---|---|---|
id | text | |
team | true or false | yes |
title | text | |
spec | object | yes |
size | one of `half`, `full` | yes |
origin | one of `person`, `hailey`, `starter` | yes |
place | one of `top`, `bottom` | yes |
{
"input": {
"team": false,
"spec": {},
"size": "half",
"origin": "person",
"place": "bottom"
}
}add_crew_day_off
Mark days a crew is off.
| Field | Type | Required |
|---|---|---|
crew_id | text | yes |
ends_on | text | yes |
reason | text | |
starts_on | text | yes |
id | text |
{
"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.
| Field | Type | Required |
|---|---|---|
caption | text | |
created_at | text | |
display_order | number | |
estimate_id | text | yes |
file_id | text | |
file_name | text | |
file_size_bytes | number | |
id | text | |
include_in_pdf | true or false | |
media_kind | text | |
mime_type | text | |
photo_url | text | yes |
section_id | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"photo_url": "photo url"
}
}add_estimate_signer
Add a signer to an estimate.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
signer_email | text | yes |
signer_name | text | yes |
signer_order | number | |
signer_role | text | |
id | text |
{
"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.
| Field | Type | Required |
|---|---|---|
description | text | |
job_id | text | yes |
metadata | any | |
title | text | yes |
type | text | yes |
id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"title": "title",
"type": "type"
}
}add_job_checklist
Add a checklist to a job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
job_id | text | yes |
name | text | yes |
template_id | text | |
items | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
checklist_id | text | yes |
heading | text | |
job_id | text | yes |
label | text | yes |
note | text | |
photo_file_id | text | |
position | number | |
quantity | number | |
status | text | |
status_at | text | |
unit | text | |
id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
item_id | text | yes |
job_id | text | yes |
file_ids | list of text | yes |
at_start | true or false |
{
"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.
| Field | Type | Required |
|---|---|---|
contact_id | text | yes |
created_at | text | |
id | text | |
job_id | text | yes |
role | text | yes |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"role": "role"
}
}add_job_tags
Tag several jobs.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
tags | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"tags": [
"tag"
]
}
}add_pin_photos
Save photos on a pin.
| Field | Type | Required |
|---|---|---|
photos | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
work_order_id | text | yes |
text | text | yes |
position | whole number |
{
"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.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
{
"input": {
"file_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}add_supplement_case_event
Add a line to a supplement case's history.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
kind | text | yes |
payload | object | yes |
{
"input": {
"case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"kind": "kind",
"payload": {}
}
}add_supplement_hand_item
Add an item the review missed.
| Field | Type | Required |
|---|---|---|
amount | number | |
bucket | text | yes |
carrier_line_ids | list of text | |
carrier_qty | number | |
case_id | text | yes |
code | text | |
confidence | number | |
correct_qty | number | |
coverage | text | |
delta_qty | number | |
engine_included | true or false | |
evidence_file_ids | list of text | |
evidence_required | list of text | |
family | text | yes |
gate | text | |
gate_field | text | |
id | text | |
included | true or false | |
issue | text | yes |
item | text | yes |
justify | any | |
note | text | |
override_qty | number | |
override_unit_price | number | |
percent | true or false | |
price_source | text | |
prior | any | |
priority | text | |
question | text | |
rank | number | |
rule_key | text | yes |
shot | text | |
trigger_fact | text | |
unit | text | yes |
unit_price | number | |
version | number | yes |
why | text | |
win_probability | number |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
work_order_id | text | yes |
note | text | yes |
day | text | |
file_ids | list of text |
{
"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.
| Field | Type | Required |
|---|---|---|
work_order_id | text | yes |
shot | text | yes |
file_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
pipeline_id | text | yes |
stage | text | yes |
{
"input": {
"pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"stage": "stage"
}
}answer_material_order_question
Answer a material order's question.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
key | one of `pipes`, `vents`, `skylights`, `chimneys`, `waste`, `edges`, `flashing`, `colors` | yes |
value | number | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"key": "pipes",
"value": 0
}
}approve_material_order
Approve a material order to send.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}assign_email_conversation
Hand an email conversation to a teammate.
| Field | Type | Required |
|---|---|---|
thread_id | text | yes |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
intake_id | text | yes |
job_id | text | yes |
engine_mode | one of `on`, `shadow`, `off` |
{
"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.
| Field | Type | Required |
|---|---|---|
conversation_id | text | yes |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
file_path | text | yes |
original_path | text | yes |
{
"input": {
"file_path": "file path",
"original_path": "original path"
}
}attach_pin_photo_original
Attach the full-size original to a pin's photo.
| Field | Type | Required |
|---|---|---|
file_path | text | yes |
original_path | text | yes |
{
"input": {
"file_path": "file path",
"original_path": "original path"
}
}attach_sender_to_contact
Add a phone number or email to a contact.
| Field | Type | Required |
|---|---|---|
contact_id | text | yes |
phone | text | |
email | text (email) |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}auto_link_eagleview_report
Attach the EagleView report at this job's address, if there is one.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}auto_link_hover_report
Attach the Hover report at this job's address, if there is one.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}build_insurance_package
Build the final insurance package PDF.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
document_id | text | |
invoice_ids | list of text | |
include_photos | true or false | |
file_ids | list of text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}build_supplement_package
Build the supplement package.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
{
"input": {
"case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}bulk_update_work_orders
Change many work orders at once (crew, days, status).
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
crew_id | text | |
sub_company_id | text | |
clear_crew | true or false | |
clear_days | true or false | |
shift_days | whole number | |
status | one of `ready`, `scheduled`, `in_progress`, `needs_check`, `done`, `canceled` |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}cancel_queued_follow_up
Stop a follow-up waiting to go out on a job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}cancel_queued_message
Cancel a text or email waiting to send.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}cancel_scheduled_email
Cancel a scheduled email.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}cancel_sms_broadcast
Cancel a text broadcast.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}change_job_person_role
Change what someone does on a job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
role | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"role": "role"
}
}change_other_buildings
Add or remove a building on a job's roof measurement.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
add | object | |
remove_index | whole number |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}check_affirm_status
Check the Affirm setup with Stripe.
It takes no input.
{
"input": {}
}check_boldsign_sender_status
Check whether the contract sender address is approved.
It takes no input.
{
"input": {}
}check_stripe_setup
Check where the Stripe setup is.
It takes no input.
{
"input": {}
}clear_default_email_signature
Stop adding a signature automatically.
It takes no input.
{
"input": {}
}copy_estimate
Copy an estimate.
| Field | Type | Required |
|---|---|---|
source_id | text | yes |
job_id | text | |
title | text | |
as_template | true or false |
{
"input": {
"source_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}copy_estimate_signers
Copy the signers onto a new estimate.
| Field | Type | Required |
|---|---|---|
source_estimate_id | text | yes |
new_estimate_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
job_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
source_workspace_id | text | yes |
types | list of text | |
dry_run | true or false | yes |
contacts_mode | one of `all`, `picked`, `none` | |
contact_ids | list of text | |
jobs_mode | one of `all`, `picked`, `none` | |
job_ids | list of text | |
stage_map | object | |
default_stage_key | text | |
copy_job_history | true or false |
{
"input": {
"source_workspace_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"dry_run": true
}
}create_change_order
Start a change order.
| Field | Type | Required |
|---|---|---|
source_id | text | yes |
base | number | yes |
{
"input": {
"source_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"base": 1
}
}create_communication_log
Log an email, text or call.
| Field | Type | Required |
|---|---|---|
ai_drafted | true or false | |
ai_summary | text | |
body | text | |
body_html | text | |
call_duration | number | |
call_route | any | |
call_status | text | |
cc_emails | list of text | |
contact_id | text | |
created_at | text | |
delivered_at | text | |
delivery_error | text | |
direction | text | |
estimate_id | text | |
external_message_id | text | |
from_email | text | |
id | text | |
in_reply_to | text | |
invoice_id | text | |
job_id | text | |
media_urls | list of text | |
message_id | text | |
opened_at | text | |
phone_number_id | text | |
read_at | text | |
recipient | text | yes |
recipient_name | text | |
recording_path | text | |
sent_at | text | |
sms_conversation_id | text | |
status | text | |
subject | text | |
supplement_submission_id | text | |
thread_id | text | |
to_emails | list of text | |
type | text | yes |
user_email_account_id | text | |
user_id | text | |
waveform_peaks | list of number |
{
"input": {
"recipient": "recipient",
"type": "type"
}
}create_contact
Add a contact.
| Field | Type | Required |
|---|---|---|
additional_phones | any | |
address | text | |
adjuster_extension | text | |
adjuster_type | text | |
assigned_to | text | |
city | text | |
claim_number | text | |
company | text | |
custom_fields | any | |
email | text | |
first_name | text | |
gate_code | text | |
id | text | |
language | text | |
last_name | text | |
notes | text | |
phone | text | |
phone_label | text | |
sms_consent | true or false | |
sms_consent_at | text | |
sms_consent_method | text | |
state | text | |
trades | list of text | |
type | text | yes |
zip | text |
{
"input": {
"type": "type"
}
}create_email_signature
Save a new email signature.
| Field | Type | Required |
|---|---|---|
name | text | yes |
body | text | yes |
is_default | true or false | yes |
format | one of `text`, `designed`, `html` | |
design | any | |
html | text |
{
"input": {
"name": "name",
"body": "body",
"is_default": true
}
}create_email_template
Save an email template.
| Field | Type | Required |
|---|---|---|
body | text | yes |
is_shared | true or false | |
name | text | yes |
subject | text |
{
"input": {
"body": "body",
"name": "name"
}
}create_estimate
Start an estimate.
| Field | Type | Required |
|---|---|---|
allow_multiple_options | true or false | |
approval_status | text | |
approved_margin | number | |
best_includes_better | true or false | |
best_package_description | text | |
best_package_enabled | true or false | |
best_package_name | text | |
better_package_description | text | |
better_package_enabled | true or false | |
better_package_name | text | |
certification_ids | list of text | |
change_order_base | number | |
cover_company_address | text | |
cover_company_email | text | |
cover_company_logo_url | text | |
cover_company_name | text | |
cover_company_phone | text | |
cover_homeowner_greeting | text | |
cover_intro_text | text | |
cover_layout | text | |
cover_logo_scale | number | |
cover_photo_focus_x | number | |
cover_photo_focus_y | number | |
cover_property_photo_url | text | |
created_at | text | |
default_margin_percent | number | |
document_type | text | |
expires_at | text | |
good_package_description | text | |
good_package_enabled | true or false | |
good_package_name | text | |
id | text | |
import_file_id | text | |
import_source | text | |
is_proposal | true or false | |
is_sample | true or false | |
is_template | true or false | |
job_id | text | |
lost_reason | text | |
lost_reason_note | text | |
notes | text | |
package_discounts | any | |
package_price_overrides | any | |
package_rates | any | |
packages_are_standalone | true or false | |
parent_estimate_id | text | |
profitability_type | text | |
proposal_cover_title | text | |
proposal_footer_text | text | |
render_engine | text | |
roof_squares | number | |
round_quantities | true or false | |
scope_heading | text | |
selected_option_keys | list of text | |
selected_tier | text | |
selected_upgrade_ids | list of text | |
selected_warranty_option_id | text | |
show_line_item_prices | true or false | |
show_line_item_quantities | true or false | |
show_line_item_totals | true or false | |
show_line_item_unit_price | true or false | |
show_line_item_uom | true or false | |
signature_field_defs | any | |
signature_method | text | |
signature_page_number | number | |
signer_email | text | |
signer_name | text | |
signing_order_enabled | true or false | |
tax_rate | number | |
terms_and_conditions | text | |
title | text | |
updated_at | text | |
valid_until | text |
{
"input": {
"allow_multiple_options": true
}
}create_estimate_line_item
Add a line to an estimate.
| Field | Type | Required |
|---|---|---|
base_quantity | number | |
created_at | text | |
description | text | |
display_order | number | |
estimate_id | text | yes |
id | text | |
is_optional | true or false | |
margin_linked | true or false | |
material_cost | number | |
measurement_field | text | |
measurement_id | text | |
name | text | yes |
product_id | text | |
profit_amount | number | |
profit_margin_percent | number | |
quantity | number | |
section_id | text | |
tier | text | |
unit_price | number | |
uom | text | yes |
updated_at | text | |
waste_percent | number |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"name": "name",
"uom": "uom"
}
}create_estimate_line_items
Add several lines to an estimate.
| Field | Type | Required |
|---|---|---|
items | list of object | yes |
{
"input": {
"items": [
{
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"name": "name",
"uom": "uom"
}
]
}
}create_estimate_pricing_package
Add a pricing option to an estimate.
| Field | Type | Required |
|---|---|---|
created_at | text | |
description | text | |
display_order | number | |
estimate_id | text | yes |
id | text | |
is_enabled | true or false | |
name | text | |
tier_key | text | yes |
updated_at | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"tier_key": "tier key"
}
}create_estimate_section
Add a section to an estimate.
| Field | Type | Required |
|---|---|---|
content | any | |
created_at | text | |
display_order | number | |
estimate_id | text | yes |
id | text | |
is_visible | true or false | |
section_type | text | yes |
show_title | true or false | |
tier | text | |
title | text | |
updated_at | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"section_type": "section type"
}
}create_estimate_warranty_option
Add a warranty option to an estimate.
| Field | Type | Required |
|---|---|---|
created_at | text | |
description | text | |
display_order | number | |
estimate_id | text | yes |
id | text | |
is_recommended | true or false | |
name | text | |
price | number | |
section_id | text | yes |
term_label | text | |
updated_at | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"section_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}create_inspection
Start an inspection on a job.
| Field | Type | Required |
|---|---|---|
answers | any | |
damage | text | |
items | any | yes |
job_id | text | yes |
slope_count | number | yes |
template_key | text | yes |
template_name | text | yes |
id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | |
job_id | text | |
contact_id | text | |
estimate_id | text | |
title | text | |
purpose | text | |
issue_date | text | |
due_date | text | |
tax_rate | number | |
discount | object | |
allow_partial_payments | true or false | |
minimum_payment | number | |
progress_group_id | text | |
progress_index | number | |
progress_count | number | |
notes | text | |
terms | text | |
line_items | list of object | yes |
line_detail | one of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only` | |
bill_to | object | |
show_claim_details | true or false |
{
"input": {
"line_items": [
{
"name": "name",
"quantity": 1,
"unit_price": 1250
}
]
}
}create_invoice_schedule
Create a payment schedule of invoices.
| Field | Type | Required |
|---|---|---|
group_id | text | |
job_id | text | |
contact_id | text | |
estimate_id | text | |
purpose | text | |
issue_date | text | |
tax_rate | number | |
allow_partial_payments | true or false | |
minimum_payment | number | |
notes | text | |
terms | text | |
line_detail | one of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only` | |
bill_to | object | |
show_claim_details | true or false | |
parts | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
accepted_estimate_id | text | |
acv_amount | number | |
adjuster_id | text | |
adjuster_meeting_at | text | |
archive_kind | text | |
archived | true or false | |
assigned_to | text | |
assignee_ids | list of text | |
cancel_reason | text | |
canvasser_id | text | |
claim_approved_at | text | |
claim_basis | text | |
claim_denied_at | text | |
claim_filed_at | text | |
claim_number | text | |
contract_date | text | |
contractor_id | text | |
cover_photo_url | text | |
custom_fields | any | |
damage_type | list of text | |
date_of_loss | text | |
deductible | number | |
dismissed_money_suggestions | list of text | |
estimated_amount | number | |
final_amount | number | |
financing_method | text | |
homeowner_id | text | |
installation_date | text | |
insurance_company | text | |
job_name | text | yes |
job_type | text | |
lead_source | text | |
mortgage_company | text | |
nonrecoverable_depreciation | number | |
pipeline_id | text | |
policy_number | text | |
primary_contact_id | text | |
priority | text | |
profit_margin | number | |
project_manager_id | text | |
property_address | text | yes |
property_city | text | |
property_county | text | |
property_state | text | |
property_type | text | |
property_zip | text | |
quick_summary | text | |
rcv_amount | number | |
recoverable_depreciation | number | |
roof_material | text | |
roof_squares | number | |
secondary_adjusters | list of text | |
secondary_contacts | list of text | |
shingle_manufacturer | text | |
shingle_product_line | text | |
sold_by | text | |
stage | text | |
stage_entered_known | true or false | |
stage_move_on | text | |
stage_move_unknown | true or false | |
storm_event_date | text | |
storm_event_details | any | |
storm_event_id | text | |
submitted_amount | number | |
supplements_amount | number | |
tags | list of text | |
trades | list of text | |
id | text |
{
"input": {
"job_name": "job name",
"property_address": "property address"
}
}create_job_cost
Add a cost to a job.
| Field | Type | Required |
|---|---|---|
amount | number | |
category | text | |
description | text | |
file_id | text | |
id | text | |
incurred_on | text | |
job_id | text | yes |
vendor | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}create_job_document
Create a job document.
| Field | Type | Required |
|---|---|---|
blocks | any | |
doc_type | text | |
id | text | |
job_id | text | yes |
pdf_form | any | |
render_engine | text | |
signature_field_defs | any | |
signature_method | text | |
signers | any | |
template_id | text | |
title | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"title": "title"
}
}create_job_file_record
Save a file or photo on a job.
| Field | Type | Required |
|---|---|---|
added_via | text | |
category | text | yes |
description | text | |
file_path | text | yes |
file_size | number | yes |
file_type | text | yes |
filename | text | yes |
inspection_id | text | |
inspection_step | text | |
job_id | text | yes |
latitude | number | |
longitude | number | |
mime_type | text | yes |
original_path | text | |
tags | list of text | |
taken_at | text | |
id | text |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | |
title | text | yes |
metric | one of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value` | yes |
starts_on | text | yes |
ends_on | text | yes |
prize | text | |
scope | one of `location`, `company` | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
total_squares | number | |
total_area_sqft | number | |
waste_factor_percent | number | |
predominant_pitch | text | |
number_of_stories | number | |
ridge_length_lf | number | |
hip_length_lf | number | |
valley_length_lf | number | |
eave_length_lf | number | |
rake_length_lf | number | |
drip_edge_lf | number | |
flashing_lf | number | |
step_flashing_lf | number | |
penetrations | object | |
pitch_breakdown | list of object | |
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}create_material_order
Create a material order.
| Field | Type | Required |
|---|---|---|
job_id | text | |
estimate_id | text | |
supplier_id | text | |
source_tier | one of `chosen`, `good`, `better`, `best` | |
delivery_date | text | |
delivery_address | text | |
delivery_notes | text | |
notes | text | |
tax_rate | number | |
additional_charges | list of object | |
items | list of object | yes |
id | text |
{
"input": {
"items": [
{
"name": "name",
"quantity": 1,
"unit_cost": 1250
}
]
}
}create_material_order_template
Create an order template.
| Field | Type | Required |
|---|---|---|
name | text | yes |
notes | text | |
supplier_id | text | |
items | list of object | |
id | text | |
sold_products | list of text |
{
"input": {
"name": "name"
}
}create_note
Add a note to a job.
| Field | Type | Required |
|---|---|---|
id | text | |
job_id | text | yes |
content | text | yes |
created_at | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"content": "content"
}
}create_photo_comment
Comment on a photo.
| Field | Type | Required |
|---|---|---|
body | text | yes |
file_id | text | |
mentioned_user_ids | list of text | |
pin_photo_id | text |
{
"input": {
"body": "body"
}
}create_photo_gallery
Make a photo share link.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
title | text | yes |
file_ids | list of text | yes |
expires_at | text | |
id | text |
{
"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.
| Field | Type | Required |
|---|---|---|
body | any | yes |
name | text | yes |
id | text |
{
"input": {
"body": "body",
"name": "name"
}
}create_pin
Drop a pin on the map.
| Field | Type | Required |
|---|---|---|
address | text | |
city | text | |
created_at | text | |
email | text | |
homeowner_first_name | text | |
homeowner_last_name | text | |
homeowner_name | text | |
id | text | |
is_shared | true or false | |
job_id | text | |
knock_position | any | |
knock_result | text | |
knock_result_option | text | |
latitude | number | yes |
longitude | number | yes |
notes | text | |
phone | text | |
pin_type | text | |
state | text | |
zip | text |
{
"input": {
"latitude": 1,
"longitude": 1
}
}create_product
Add a product.
| Field | Type | Required |
|---|---|---|
category | text | |
cost | number | |
coverage_per_unit | number | |
default_price | number | |
description | text | |
id | text | |
is_active | true or false | |
item_type | one of `regular`, `upgrade` | |
measurement_basis | text | |
name | text | yes |
sku | text | |
uom | text | |
waste_percent | number |
{
"input": {
"name": "name"
}
}create_products
Add many products.
| Field | Type | Required |
|---|---|---|
products | list of object | yes |
{
"input": {
"products": [
{
"name": "name"
}
]
}
}create_products_skipping_taken_names
Add products, leaving out the ones already in the list.
| Field | Type | Required |
|---|---|---|
products | list of object | yes |
{
"input": {
"products": [
{
"name": "name"
}
]
}
}create_report
Save a report.
| Field | Type | Required |
|---|---|---|
id | text | |
share | one of `me`, `location`, `company` | yes |
title | text | yes |
description | text | |
folder | text | |
spec | object | yes |
view | object | |
templateKey | text | |
pinned | true or false |
{
"input": {
"share": "me",
"title": "title",
"spec": {}
}
}create_sms_broadcast
Build a text broadcast.
| Field | Type | Required |
|---|---|---|
name | text | |
body | text | yes |
company_name | text | |
rep_name | text | |
rep_phone | text | |
scheduled_for | text | |
recipients | list of object | yes |
id | text | |
from_phone_id | text |
{
"input": {
"body": "body",
"recipients": [
{
"phone": "+16155550148",
"opted_out": true
}
]
}
}create_stage_tasks
Create the tasks a stage calls for.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
new_stage | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"new_stage": "new stage"
}
}create_supplier
Add a supplier.
| Field | Type | Required |
|---|---|---|
account_number | text | |
address | text | |
contact_name | text | |
email | text | |
id | text | |
is_active | true or false | |
name | text | yes |
notes | text | |
phone | text |
{
"input": {
"name": "name"
}
}create_task
Add a task.
| Field | Type | Required |
|---|---|---|
adjuster_result | text | |
appointment_option | text | |
appointment_type | text | |
assigned_to | text | |
attendee_ids | list of text | |
calendar_event_id | text | |
calendar_id | text | |
completed | true or false | |
completed_at | text | |
contact_id | text | |
customer_reminder | text | |
customer_reminder_sent_at | text | |
description | text | |
done_when | text | |
done_when_stage | text | |
due_date | text | |
duration_minutes | number | |
end_date | text | |
followup_nudge_sent_at | text | |
homeowner_messages | true or false | |
id | text | |
job_id | text | |
location | text | |
notification_id | text | |
outcome | text | |
outcome_recorded_at | text | |
priority | text | |
reminder_minutes | number | |
series_id | text | |
title | text | yes |
{
"input": {
"title": "title"
}
}create_task_series
Make an event repeat.
| Field | Type | Required |
|---|---|---|
series_id | text | yes |
starts_on | text | yes |
rule | object | yes |
template | object | yes |
adopt_task_id | text |
{
"input": {
"series_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"starts_on": "2026-11-19",
"rule": {},
"template": {}
}
}create_tasks
Add several tasks.
| Field | Type | Required |
|---|---|---|
tasks | list of object | yes |
{
"input": {
"tasks": [
{
"title": "title"
}
]
}
}create_tracked_supplement
Log a supplement on a job.
| Field | Type | Required |
|---|---|---|
amount_approved | number | |
amount_requested | number | |
closed_at | text | |
job_id | text | yes |
layer | number | yes |
notes | text | |
outcome | text | |
sent_at | text | |
status | text | |
id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"layer": 1
}
}create_work_order
Make a work order on a job.
| Field | Type | Required |
|---|---|---|
arrival_time | text | |
auto_created | true or false | |
colors | text | |
crew_id | text | |
days | number | |
depends_on | text | |
hoa_status | text | |
homeowner_told_at | text | |
job_id | text | yes |
material_order_id | text | |
materials_notes | text | |
permit_status | text | |
photo_items | any | |
position | number | |
required_shots | list of text | |
scope | any | |
scope_note | text | |
site_notes | text | |
source_estimate_id | text | |
squares | number | |
start_date | text | |
status | text | |
sub_company_id | text | |
title | text | |
trade | text | |
trades | list of text | |
id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}decide_work_order_issue
Approve or decline a problem the crew reported.
| Field | Type | Required |
|---|---|---|
id | text | yes |
status | one of `approved`, `declined`, `open` | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"status": "approved"
}
}detach_sender_from_contact
Take a phone number or email back off a contact.
| Field | Type | Required |
|---|---|---|
contact_id | text | yes |
phone | text | |
email | text (email) |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}dismiss_order_list_suggestion
Stop offering a change to an order list.
| Field | Type | Required |
|---|---|---|
template_id | text | yes |
key | text | yes |
{
"input": {
"template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"key": "key"
}
}dismiss_photo_suggestions
Say no to the suggestions on photos.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
{
"input": {
"file_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}dismiss_supplement_intake
Set an arrived carrier estimate aside.
| Field | Type | Required |
|---|---|---|
intake_id | text | yes |
{
"input": {
"intake_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}draft_material_order_from_measurements
Draft a material order from the roof's measurements.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
template_id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}draft_supplement_rebuttal
Draft a rebuttal to the carrier.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
{
"input": {
"case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}drop_storm_list_pins
Drop a pin on every house in a storm list.
| Field | Type | Required |
|---|---|---|
list_id | text | yes |
assign_to_user_id | text |
{
"input": {
"list_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}ensure_estimate_signer
Make sure a signer is on an estimate.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
signer_email | text | yes |
signer_name | text | yes |
signer_order | number | |
signer_role | text | |
id | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"signer_email": "dana@example.com",
"signer_name": "signer name"
}
}ensure_job_site_link
Make a job QR sign link.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}estimate_storm_list
Count and price a storm list before building it.
| Field | Type | Required |
|---|---|---|
name | text | yes |
range | object | yes |
window_from | text | yes |
window_to | text | yes |
min_size_in | number | yes |
area | object | yes |
property_cap | whole number | yes |
dedupe_days | whole number | |
assignee_ids | list of text | yes |
color | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
file_id | text | yes |
engine_mode | one of `on`, `shadow`, `off` |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}extract_measurements
Read the measurements from an uploaded report.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
file_id | text | yes |
source_type | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
latitude | number | yes |
longitude | number | yes |
{
"input": {
"latitude": -90,
"longitude": -180
}
}fetch_roof_sketch_picture
Get the satellite picture to draw a roof on.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
zoom | number | |
center | object |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}file_job_document_pdf
Save a document's PDF in the job's files.
| Field | Type | Required |
|---|---|---|
kind | one of `estimate`, `invoice`, `material_order`, `work_order`, `code_report`, `measurement_report` | yes |
record_id | text | yes |
job_id | text | |
document_number | text | |
title | text | |
pdf_url | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
phone | text | yes |
{
"input": {
"phone": "+16155550148"
}
}finish_import_run
Mark an import finished.
| Field | Type | Required |
|---|---|---|
run_id | text | yes |
failed | true or false |
{
"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.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
measurement_id | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}forget_import_choices
Forget the choices kept from a system's imports.
| Field | Type | Required |
|---|---|---|
source | one of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate` | yes |
{
"input": {
"source": "spreadsheet"
}
}generate_code_report_pdf
Make the PDF of the building code report.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
manufacturer | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_customer_statement
Make a customer statement.
| Field | Type | Required |
|---|---|---|
contact_id | text | |
job_id | text |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_invoice_pdf
Make the PDF of an invoice.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_job_document_pdf
Make the PDF of a job document.
| Field | Type | Required |
|---|---|---|
document_id | text | yes |
{
"input": {
"document_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_material_order_pdf
Make a material order's PDF.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
include_pricing | true or false |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_measurement_report_pdf
Make the PDF of a roof measurement report.
| Field | Type | Required |
|---|---|---|
measurement_id | text | yes |
{
"input": {
"measurement_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_photo_report
Make a photo report PDF.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
spec | object | |
file_ids | list of text | |
share_with_homeowner | true or false | |
timeout_ms | whole number |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_storm_report
Make a storm verification report.
| Field | Type | Required |
|---|---|---|
job_id | text | |
pin_id | text | |
latitude | number | |
longitude | number | |
address | text | |
city | text | |
state | text | |
zip | text | |
significant_date | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}generate_work_order_pdf
Make the crew work order.
| Field | Type | Required |
|---|---|---|
estimate_id | text | |
work_order_id | text | |
colour | text | |
crew_notes | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}get_companycam_status
See whether CompanyCam is connected.
It takes no input.
{
"input": {}
}get_house_facts
Read a job's house: elevation, drone ceiling and storms.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}get_my_referral_code
Get this company's referral link.
It takes no input.
{
"input": {}
}import_companycam_projects
Import CompanyCam projects as jobs.
| Field | Type | Required |
|---|---|---|
project_ids | list of text | |
items | list of object | |
pipeline_id | text | |
stage_key | text |
{
"input": {
"project_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}import_contact_email_history
Bring in a contact's old emails.
| Field | Type | Required |
|---|---|---|
contact_id | text | yes |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}import_mailbox_email_history
Bring in recent email history.
It takes no input.
{
"input": {}
}import_spreadsheet_rows
Import a batch of rows from a spreadsheet.
| Field | Type | Required |
|---|---|---|
pipeline_id | text | yes |
rows | list of object | yes |
run_id | text | |
source | one of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate` | |
file_name | text | |
row_count | whole number | |
settings | object |
{
"input": {
"pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"rows": [
{}
]
}
}import_supplier_template
Import a template from the supplier's account.
| Field | Type | Required |
|---|---|---|
template_id | text | yes |
name | text |
{
"input": {
"template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}import_template_from_file
Read a file or pasted text into a template.
| Field | Type | Required |
|---|---|---|
kind | one of `estimate`, `products`, `document`, `inspection` | yes |
file_content | text | |
file_mime | text | |
file_name | text | |
pdf_form | one of `auto`, `never`, `always` | |
pasted_text | text | |
answers | list of object |
{
"input": {
"kind": "estimate"
}
}leave_appointment
Say you can't make an appointment.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}link_companycam_project
Link a job to a CompanyCam project.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
companycam_project_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"companycam_project_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}link_contact_to_sms_conversation
Attach a contact to a text conversation.
| Field | Type | Required |
|---|---|---|
sms_conversation_id | text | yes |
contact_id | text | yes |
{
"input": {
"sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}link_eagleview_report
Attach an EagleView report you already have to a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
report_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"report_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}link_hover_report
Attach a Hover report you already have to a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
hover_job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"hover_job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}link_storm_list_property_to_pin
Mark a storm list house as the pin it became.
| Field | Type | Required |
|---|---|---|
property_id | text | yes |
pin_id | text | yes |
{
"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.
{
"input": {}
}list_google_calendars
List your Google calendars.
It takes no input.
{
"input": {}
}list_importable_companycam_projects
List the CompanyCam projects that could be imported.
It takes no input.
{
"input": {}
}look_up_property_owner
Look up who owns a house.
| Field | Type | Required |
|---|---|---|
latitude | number | yes |
longitude | number | yes |
saved_only | true or false |
{
"input": {
"latitude": -90,
"longitude": -180
}
}mark_all_notifications_read
Mark all notifications read.
It takes no input.
{
"input": {}
}mark_email_conversation_handled
Mark an email conversation as read for the team.
| Field | Type | Required |
|---|---|---|
thread_id | text | yes |
{
"input": {
"thread_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_email_thread_read
Mark an email thread as read.
| Field | Type | Required |
|---|---|---|
contact_id | text | |
contact_email | text | |
owner_user_id | text | |
explicit | true or false | |
mailbox_id | text |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_inbox_thread_unread
Mark a conversation unread.
| Field | Type | Required |
|---|---|---|
sms_conversation_id | text | |
contact_id | text | |
contact_email | text | |
owner_user_id | text |
{
"input": {
"sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_invoice_sent
Mark an invoice sent.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_notification_read
Mark a notification read.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_notifications_read
Mark several notifications read.
| Field | Type | Required |
|---|---|---|
notification_ids | list of text | yes |
{
"input": {
"notification_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}mark_sister_jobs_different
Say jobs in two sister companies are different jobs.
| Field | Type | Required |
|---|---|---|
pairs | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
sms_conversation_id | text | yes |
explicit | true or false |
{
"input": {
"sms_conversation_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_supplement_sent
Record that the supplement package was sent.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
submission_id | text | yes |
sent_to | list of text | yes |
cc | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
{
"input": {
"case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_support_replies_read
Mark support replies as seen.
| Field | Type | Required |
|---|---|---|
request_id | text | yes |
{
"input": {
"request_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}mark_work_order_materials_arrived
Mark the materials delivered at the job.
| Field | Type | Required |
|---|---|---|
work_order_id | text | yes |
file_id | text | |
at | text |
{
"input": {
"work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}measure_roof_at_point
Measure the roof at a spot on the map.
| Field | Type | Required |
|---|---|---|
latitude | number | yes |
longitude | number | yes |
address | text | |
other_building | true or false |
{
"input": {
"latitude": -90,
"longitude": -180
}
}measure_roof_instantly
Measure a job's roof from the satellite.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
reading_id | text | |
extra_reading_ids | list of text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}move_email_conversation
Move an email conversation to another location.
| Field | Type | Required |
|---|---|---|
thread_id | text | yes |
to_workspace_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
stage | text | yes |
reason | text | yes |
pipeline_id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"stage": "stage",
"reason": "reason"
}
}move_job_to_stage
Move a job to a stage.
| Field | Type | Required |
|---|---|---|
id | text | yes |
stage | text | yes |
pipeline_id | text | |
entered_at | text | |
date_known | true or false | |
moved_on | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"stage": "stage"
}
}move_photos_to_job
Move photos to another job.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
job_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
before_id | text | yes |
after_id | text | yes |
pair_group | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}peek_roof_reading
See the roof reading already kept for a spot.
| Field | Type | Required |
|---|---|---|
latitude | number | yes |
longitude | number | yes |
address | text |
{
"input": {
"latitude": -90,
"longitude": -180
}
}prepare_rebuttal_attachments
Get the files a rebuttal goes out with.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
package_file_id | text | yes |
body | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
rows | list of object | yes |
source | one of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate` | |
known_keys | list of text |
{
"input": {
"rows": [
{}
]
}
}price_supplier_order_items
Get live supplier prices for an order.
| Field | Type | Required |
|---|---|---|
material_order_id | text | yes |
ship_to_number | text | yes |
branch_number | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
file_id | text | yes |
{
"input": {
"file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}read_job_files_for_money
Read a job's waiting files for costs and payments.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}read_roof_facts_from_photos
Read a job's roof facts from its photos.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}record_supplement_outcomes
Record what the carrier said about each item.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
submission_id | text | yes |
outcomes | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
template_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}refile_communication
Move a message to another job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
job_id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}refresh_measurement_orders
Check on the roof measurement orders.
| Field | Type | Required |
|---|---|---|
job_id | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remember_supplier_item_mappings
Remember supplier item numbers.
| Field | Type | Required |
|---|---|---|
provider | text | yes |
mappings | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_analytics_chart
Take a chart off the charts in Reports.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"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).
| Field | Type | Required |
|---|---|---|
item_id | text | yes |
file_id | text | yes |
{
"input": {
"item_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_job_tags
Take tags off several jobs.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
tags | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"tags": [
"tag"
]
}
}remove_showcase_photos
Take photos off the showcase page.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
{
"input": {
"file_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}remove_work_order_shot
Take a photo off one of a work order's required shots.
| Field | Type | Required |
|---|---|---|
work_order_id | text | yes |
shot | text | yes |
file_id | text | yes |
{
"input": {
"work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"shot": "shot",
"file_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}renew_work_order_crew_link
Make a new link to a work order's crew sheet.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}reorder_estimate_rows
Put an estimate's sections, lines or options in a new order.
| Field | Type | Required |
|---|---|---|
table | one of `estimate_sections`, `estimate_line_items`, `estimate_photos`, `estimate_pricing_packages`, `estimate_warranty_options` | yes |
ids | list of text | yes |
{
"input": {
"table": "estimate_sections",
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}reorder_estimate_signers
Change the signing order.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
ordered_ids | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
document_id | text | yes |
signers | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
items | list of object | yes |
tax_rate | number | |
additional_charges | list of object |
{
"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.
| Field | Type | Required |
|---|---|---|
template_id | text | yes |
items | list of object | yes |
{
"input": {
"template_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"items": [
{
"name": "name"
}
]
}
}report_code_answer
Say a code answer is wrong.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
field | text | yes |
answer | one of `yes`, `no` | yes |
note | text |
{
"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).
| Field | Type | Required |
|---|---|---|
file_ids | list of text | |
note | text | yes |
quantity | number | |
unit | text | |
work_order_id | text | yes |
id | text |
{
"input": {
"note": "note",
"work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}request_job_access
Ask to be added to a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}request_work_order_materials
Ask the office for more materials, or to return leftovers.
| Field | Type | Required |
|---|---|---|
work_order_id | text | yes |
kind | one of `addon`, `return` | yes |
lines | list of object | yes |
note | text | |
id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
contact_id | text | yes |
{
"input": {
"contact_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}restore_deleted_job
Put a deleted job back.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}restore_deleted_media
Put a deleted photo or file back.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}restore_deleted_record
Put back a deleted note, estimate, contract, task, invoice, payment or pin.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}restore_jobs
Put several jobs back how they were.
| Field | Type | Required |
|---|---|---|
jobs | list of object | yes |
{
"input": {
"jobs": [
{
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
]
}
}retry_failed_sister_sync
Try the failed sister company sends again.
| Field | Type | Required |
|---|---|---|
source_workspace_id | text | yes |
target_workspace_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
knock_id | text | yes |
reviewed | true or false | yes |
{
"input": {
"knock_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"reviewed": true
}
}run_export_now
Make an export file now.
| Field | Type | Required |
|---|---|---|
schedule_id | text | |
name | text | |
items | list of object | |
format | one of `xlsx`, `csv`, `json` | |
deliver | true or false | |
wait_seconds | whole number |
{
"input": {
"schedule_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}run_supplement_review
Run the supplement review for a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
carrier_scope_id | text | |
source | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}save_analytics_alert
Set an alert on a number.
| Field | Type | Required |
|---|---|---|
id | text | |
spec | object | yes |
condition | one of `above`, `below`, `up_by`, `down_by`, `report` | yes |
threshold | number | yes |
cadence | one of `daily`, `weekly` | yes |
active | true or false | yes |
{
"input": {
"spec": {},
"condition": "above",
"threshold": 0,
"cadence": "daily",
"active": true
}
}save_analytics_page
Save the charts in Reports in their new order.
| Field | Type | Required |
|---|---|---|
team | true or false | yes |
cards | list of object | yes |
{
"input": {
"team": false,
"cards": [
{
"spec": {},
"size": "half",
"origin": "person"
}
]
}
}save_email_draft
Save an email draft.
| Field | Type | Required |
|---|---|---|
attachments | any | |
bcc_emails | list of text | |
body | text | |
cc_emails | list of text | |
contact_id | text | |
id | text | |
in_reply_to | text | |
job_id | text | |
quoted_message_id | text | |
reply_mode | text | |
subject | text | |
thread_id | text | |
to_emails | list of text |
{
"input": {
"attachments": "attachments"
}
}save_invoice_edits
Change an invoice's details and lines.
| Field | Type | Required |
|---|---|---|
id | text | yes |
job_id | text | |
contact_id | text | |
estimate_id | text | |
title | text | |
purpose | text | |
issue_date | text | |
due_date | text | |
tax_rate | number | |
discount | object | |
allow_partial_payments | true or false | |
minimum_payment | number | |
notes | text | |
terms | text | |
line_detail | one of `full`, `line_totals`, `total_only`, `quantity_total`, `price_total`, `quantity_price`, `quantity_only`, `price_only` | |
bill_to | one of `customer`, `insurance`, `mortgage`, `other` | |
bill_to_name | text | |
bill_to_email | text | |
bill_to_reference | text | |
show_claim_details | true or false | |
line_items | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
note | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"note": "note"
}
}save_note_mentions
Save who a note mentions.
| Field | Type | Required |
|---|---|---|
note_id | text | yes |
job_id | text | yes |
mentioned_user_ids | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
facts | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}save_roof_sketch
Save a roof drawing as the job's measurement.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
existing | object | yes |
fields | object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
query | text | yes |
{
"input": {
"query": "query"
}
}search_companycam_projects
Search the company's CompanyCam projects.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
query | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}set_crew_lead
Make somebody a crew's lead.
| Field | Type | Required |
|---|---|---|
crew_id | text | yes |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}set_default_material_order_template
Set the default order template.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}set_estimate_photo_caption
Change a photo caption on an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
caption | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"caption": "caption"
}
}set_estimate_photo_in_pdf
Include or leave out a photo in the estimate PDF.
| Field | Type | Required |
|---|---|---|
id | text | yes |
include_in_pdf | true or false | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"include_in_pdf": true
}
}set_estimate_status
Move an estimate to another status.
| Field | Type | Required |
|---|---|---|
status | text | |
id | text | yes |
{
"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).
| Field | Type | Required |
|---|---|---|
file_id | text | yes |
dismissed | true or false | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
link_id | text | yes |
on | true or false | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
not_needed | true or false | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"not_needed": true
}
}set_measurement_report_source
Say whose report a roof measurement was read from.
| Field | Type | Required |
|---|---|---|
id | text | yes |
source_type | one of `eagleview`, `hover`, `roofr`, `gaf`, `other` | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"source_type": "eagleview"
}
}set_measurement_waste_factor
Change a roof measurement's waste factor.
| Field | Type | Required |
|---|---|---|
id | text | yes |
waste_percent | number | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"waste_percent": 0
}
}set_my_language
Choose the language of my crew screens.
| Field | Type | Required |
|---|---|---|
language | one of `en`, `es` | yes |
{
"input": {
"language": "en"
}
}set_photo_gallery_turned_off
Turn a photo share link off (or back on).
| Field | Type | Required |
|---|---|---|
id | text | yes |
turned_off | true or false | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"turned_off": true
}
}set_photo_report_shared
Show a photo report on the homeowner page (or stop).
| Field | Type | Required |
|---|---|---|
id | text | yes |
share_with_homeowner | true or false | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"share_with_homeowner": true
}
}set_photo_tags
Tag several photos at once.
| Field | Type | Required |
|---|---|---|
updates | list of object | yes |
{
"input": {
"updates": [
{
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"tags": [
"tag"
]
}
]
}
}set_pin_photo_caption
Change a pin photo's caption.
| Field | Type | Required |
|---|---|---|
id | text | yes |
caption | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"caption": "caption"
}
}set_pin_photo_tags
Change a pin photo's tags.
| Field | Type | Required |
|---|---|---|
id | text | yes |
tags | list of text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"tags": [
"tag"
]
}
}set_recommended_warranty_option
Mark the recommended warranty option.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
option_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
on | true or false | yes |
{
"input": {
"on": true
}
}set_work_order_pay
Set a work order's crew pay, or mark it paid.
| Field | Type | Required |
|---|---|---|
work_order_id | text | yes |
amount | number | |
paid_at | text (date-time) | |
lines | list of object |
{
"input": {
"work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}shift_work_orders
Move builds for a rain day.
| Field | Type | Required |
|---|---|---|
day | text | yes |
crew_ids | list of text | yes |
by | whole number | yes |
{
"input": {
"day": "2026-11-19",
"crew_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"by": -30
}
}snooze_notifications
Snooze notifications.
| Field | Type | Required |
|---|---|---|
notification_ids | list of text | yes |
until | text | yes |
{
"input": {
"notification_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"until": "until"
}
}stage_import_rows
Hand over the rows of an import.
| Field | Type | Required |
|---|---|---|
run_id | text | yes |
pipeline_id | text | yes |
rows | list of object | yes |
offset | whole number | yes |
source | one of `spreadsheet`, `acculynx`, `jobnimbus`, `roofr`, `hailmate` | |
file_name | text | |
row_count | whole number | yes |
settings | object |
{
"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.
| Field | Type | Required |
|---|---|---|
starter | one of `good_better_best`, `one_price`, `itemized`, `insurance`, `repair` | yes |
id | text | |
job_id | text | |
title | text | |
saved_option_ids | list of text | |
carrier_scope_id | text | |
measurement_id | text | |
as_template | true or false |
{
"input": {
"starter": "good_better_best"
}
}start_import_run
Start an import in the background.
| Field | Type | Required |
|---|---|---|
run_id | text | yes |
{
"input": {
"run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}step_work_order
Say a work order started or finished.
| Field | Type | Required |
|---|---|---|
id | text | yes |
step | one of `started`, `finished`, `undo_started`, `undo_finished`, `accepted`, `on_way` | yes |
at | text (date-time) |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"step": "started"
}
}sync_companycam_job
Sync a job's photos with CompanyCam now.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
shingle_manufacturer | text | yes |
shingle_product_line | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
bill_to_number | text | yes |
branch_number | text |
{
"input": {
"bill_to_number": "bill to number"
}
}take_back_material_order_approval
Take back a material order's approval.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}undo_invoice_sent
Take back an invoice send that never went out.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
sent_at | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
file_ids | list of text | yes |
before | object |
{
"input": {
"file_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}unlink_companycam_project
Stop syncing a job with CompanyCam.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}unpair_job_photos
Take two photos out of a before and after pair.
| Field | Type | Required |
|---|---|---|
pair_group | text | yes |
{
"input": {
"pair_group": "pair group"
}
}unsnooze_notifications
Bring snoozed notifications back.
| Field | Type | Required |
|---|---|---|
notification_ids | list of text | yes |
{
"input": {
"notification_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}update_analytics_chart
Change a chart in Reports.
| Field | Type | Required |
|---|---|---|
id | text | yes |
title | text | |
spec | object | |
size | one of `half`, `full` |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_communication_log
Change a logged email, text or call.
| Field | Type | Required |
|---|---|---|
ai_drafted | true or false | |
ai_summary | text | |
body | text | |
body_html | text | |
call_duration | number | |
call_route | any | |
call_status | text | |
cc_emails | list of text | |
contact_id | text | |
delivered_at | text | |
delivery_error | text | |
direction | text | |
estimate_id | text | |
external_message_id | text | |
from_email | text | |
id | text | yes |
in_reply_to | text | |
invoice_id | text | |
job_id | text | |
media_urls | list of text | |
message_id | text | |
opened_at | text | |
phone_number_id | text | |
read_at | text | |
recipient | text | |
recipient_name | text | |
recording_path | text | |
sent_at | text | |
sms_conversation_id | text | |
status | text | |
subject | text | |
supplement_submission_id | text | |
thread_id | text | |
to_emails | list of text | |
type | text | |
user_email_account_id | text | |
waveform_peaks | list of number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_contact
Change a contact's details.
| Field | Type | Required |
|---|---|---|
additional_phones | any | |
address | text | |
adjuster_extension | text | |
adjuster_type | text | |
assigned_to | text | |
city | text | |
claim_number | text | |
company | text | |
custom_fields | any | |
email | text | |
first_name | text | |
gate_code | text | |
id | text | yes |
language | text | |
last_name | text | |
notes | text | |
phone | text | |
phone_label | text | |
sms_consent | true or false | |
sms_consent_at | text | |
sms_consent_method | text | |
state | text | |
trades | list of text | |
type | text | |
zip | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_contacts
Change several contacts.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
changes | object | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"changes": {
"address": "address"
}
}
}update_crew_document
Change when a crew's paper runs out.
| Field | Type | Required |
|---|---|---|
expires_on | text | |
kind | text | |
label | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_eagleview_order_address
Fix the address on an EagleView order.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
address | text | yes |
city | text | yes |
state | text | yes |
zip | text | yes |
latitude | number | |
longitude | number |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"address": "address",
"city": "city",
"state": "state",
"zip": "zip"
}
}update_email_signature
Change an email signature.
| Field | Type | Required |
|---|---|---|
id | text | yes |
name | text | yes |
body | text | yes |
is_default | true or false | yes |
format | one of `text`, `designed`, `html` | |
design | any | |
html | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"name": "name",
"body": "body",
"is_default": true
}
}update_email_template
Change an email template.
| Field | Type | Required |
|---|---|---|
body | text | |
is_shared | true or false | |
name | text | |
subject | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate
Change an estimate.
| Field | Type | Required |
|---|---|---|
allow_multiple_options | true or false | |
approval_status | text | |
approved_margin | number | |
best_includes_better | true or false | |
best_package_description | text | |
best_package_enabled | true or false | |
best_package_name | text | |
better_package_description | text | |
better_package_enabled | true or false | |
better_package_name | text | |
certification_ids | list of text | |
change_order_base | number | |
cover_company_address | text | |
cover_company_email | text | |
cover_company_logo_url | text | |
cover_company_name | text | |
cover_company_phone | text | |
cover_homeowner_greeting | text | |
cover_intro_text | text | |
cover_layout | text | |
cover_logo_scale | number | |
cover_photo_focus_x | number | |
cover_photo_focus_y | number | |
cover_property_photo_url | text | |
created_at | text | |
default_margin_percent | number | |
document_type | text | |
estimate_number | text | |
expires_at | text | |
good_package_description | text | |
good_package_enabled | true or false | |
good_package_name | text | |
id | text | yes |
import_file_id | text | |
import_source | text | |
is_proposal | true or false | |
is_sample | true or false | |
is_template | true or false | |
job_id | text | |
lost_reason | text | |
lost_reason_note | text | |
notes | text | |
package_discounts | any | |
package_price_overrides | any | |
package_rates | any | |
packages_are_standalone | true or false | |
parent_estimate_id | text | |
profitability_type | text | |
proposal_cover_title | text | |
proposal_footer_text | text | |
render_engine | text | |
roof_squares | number | |
round_quantities | true or false | |
scope_heading | text | |
selected_option_keys | list of text | |
selected_tier | text | |
selected_upgrade_ids | list of text | |
selected_warranty_option_id | text | |
show_line_item_prices | true or false | |
show_line_item_quantities | true or false | |
show_line_item_totals | true or false | |
show_line_item_unit_price | true or false | |
show_line_item_uom | true or false | |
signature_field_defs | any | |
signature_method | text | |
signature_page_number | number | |
signer_email | text | |
signer_name | text | |
signing_order_enabled | true or false | |
status | text | |
tax_rate | number | |
terms_and_conditions | text | |
title | text | |
updated_at | text | |
valid_until | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate_line_item
Change a line of an estimate.
| Field | Type | Required |
|---|---|---|
base_quantity | number | |
created_at | text | |
description | text | |
display_order | number | |
id | text | yes |
is_optional | true or false | |
margin_linked | true or false | |
material_cost | number | |
measurement_field | text | |
measurement_id | text | |
name | text | |
product_id | text | |
profit_amount | number | |
profit_margin_percent | number | |
quantity | number | |
section_id | text | |
tier | text | |
unit_price | number | |
uom | text | |
updated_at | text | |
waste_percent | number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate_line_items
Re-price several lines of an estimate.
| Field | Type | Required |
|---|---|---|
changes | list of object | yes |
{
"input": {
"changes": [
{
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
]
}
}update_estimate_pricing_package
Change a pricing option on an estimate.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
is_enabled | true or false | |
name | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate_section
Change a section of an estimate.
| Field | Type | Required |
|---|---|---|
content | any | |
created_at | text | |
display_order | number | |
id | text | yes |
is_visible | true or false | |
section_type | text | |
show_title | true or false | |
tier | text | |
title | text | |
updated_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate_signer
Change a signer on an estimate.
| Field | Type | Required |
|---|---|---|
signer_email | text | |
signer_name | text | |
signer_order | number | |
signer_role | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_estimate_warranty_option
Change a warranty option on an estimate.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
is_recommended | true or false | |
name | text | |
price | number | |
term_label | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_inspection
Change an inspection.
| Field | Type | Required |
|---|---|---|
answers | any | |
damage | text | |
items | any | |
slope_count | number | |
status | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_invoice
Change an invoice.
| Field | Type | Required |
|---|---|---|
allow_partial_payments | true or false | |
autopay | true or false | |
autopay_method_id | text | |
due_date | text | |
financing_pending | true or false | |
late_fee_exempt | true or false | |
reminders_paused | true or false | |
status | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_job
Change a job.
| Field | Type | Required |
|---|---|---|
accepted_estimate_id | text | |
acv_amount | number | |
adjuster_id | text | |
adjuster_meeting_at | text | |
archive_kind | text | |
archived | true or false | |
assigned_to | text | |
assignee_ids | list of text | |
cancel_reason | text | |
canvasser_id | text | |
claim_approved_at | text | |
claim_basis | text | |
claim_denied_at | text | |
claim_filed_at | text | |
claim_number | text | |
contract_date | text | |
contractor_id | text | |
cover_photo_url | text | |
custom_fields | any | |
damage_type | list of text | |
date_of_loss | text | |
deductible | number | |
dismissed_money_suggestions | list of text | |
estimated_amount | number | |
final_amount | number | |
financing_method | text | |
homeowner_id | text | |
installation_date | text | |
insurance_company | text | |
job_name | text | |
job_type | text | |
lead_source | text | |
lost_reason | text | |
mortgage_company | text | |
nonrecoverable_depreciation | number | |
pipeline_id | text | |
policy_number | text | |
primary_contact_id | text | |
priority | text | |
profit_margin | number | |
project_manager_id | text | |
property_address | text | |
property_city | text | |
property_county | text | |
property_state | text | |
property_type | text | |
property_zip | text | |
quick_summary | text | |
rcv_amount | number | |
recoverable_depreciation | number | |
roof_material | text | |
roof_squares | number | |
secondary_adjusters | list of text | |
secondary_contacts | list of text | |
shingle_manufacturer | text | |
shingle_product_line | text | |
sold_by | text | |
stage | text | |
stage_entered_at | text | |
stage_entered_known | true or false | |
stage_move_on | text | |
stage_move_unknown | true or false | |
storm_event_date | text | |
storm_event_details | any | |
storm_event_id | text | |
submitted_amount | number | |
supplements_amount | number | |
tags | list of text | |
trades | list of text | |
id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
name | text | |
removed_at | text | |
template_id | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_job_checklist_item
Tick or change an item on a job's checklist.
| Field | Type | Required |
|---|---|---|
heading | text | |
label | text | |
note | text | |
photo_file_id | text | |
position | number | |
quantity | number | |
status | text | |
status_at | text | |
unit | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_job_cost
Change a job cost.
| Field | Type | Required |
|---|---|---|
amount | number | |
category | text | |
description | text | |
file_id | text | |
id | text | yes |
incurred_on | text | |
job_id | text | |
updated_at | text | |
vendor | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_job_document
Change a job document.
| Field | Type | Required |
|---|---|---|
blocks | any | |
doc_type | text | |
id | text | yes |
job_id | text | |
pdf_form | any | |
render_engine | text | |
signature_field_defs | any | |
signature_method | text | |
signers | any | |
status | text | |
template_id | text | |
title | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_job_file
Rename, tag or caption a file or photo.
| Field | Type | Required |
|---|---|---|
category | text | |
description | text | |
filename | text | |
tags | list of text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_jobs
Change several jobs.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
changes | object | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"changes": {
"accepted_estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}
}update_leaderboard_contest
Change a leaderboard contest.
| Field | Type | Required |
|---|---|---|
id | text | yes |
title | text | |
metric | one of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value` | |
starts_on | text | |
ends_on | text | |
prize | text | |
scope | one of `location`, `company` |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_material_order
Change a material order.
| Field | Type | Required |
|---|---|---|
additional_charges | any | |
delivered_at | text | |
delivery_address | text | |
delivery_address_line1 | text | |
delivery_address_line2 | text | |
delivery_city | text | |
delivery_contact_name | text | |
delivery_contact_phone | text | |
delivery_date | text | |
delivery_notes | text | |
delivery_postal | text | |
delivery_state | text | |
estimate_id | text | |
id | text | yes |
job_id | text | |
kind | text | |
notes | text | |
parent_order_id | text | |
source_tier | text | |
status | text | |
supplier_id | text | |
takeoff_asked_at | text | |
tax_rate | number | |
template_id | text | |
updated_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_material_order_item_supplier_data
Apply a supplier's item numbers and prices to an order.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
updates | list of object | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"updates": [
{
"item_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
]
}
}update_material_order_template
Change an order template.
| Field | Type | Required |
|---|---|---|
name | text | |
notes | text | |
sold_products | list of text | |
supplier_id | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_measurement
Change a job's roof measurements.
| Field | Type | Required |
|---|---|---|
total_squares | number | |
total_area_sqft | number | |
waste_factor_percent | number | |
predominant_pitch | text | |
number_of_stories | number | |
ridge_length_lf | number | |
hip_length_lf | number | |
valley_length_lf | number | |
eave_length_lf | number | |
rake_length_lf | number | |
drip_edge_lf | number | |
flashing_lf | number | |
step_flashing_lf | number | |
penetrations | object | |
pitch_breakdown | list of object | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_note
Change a note.
| Field | Type | Required |
|---|---|---|
id | text | yes |
content | text | |
job_id | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_pin
Change a pin.
| Field | Type | Required |
|---|---|---|
address | text | |
city | text | |
email | text | |
homeowner_first_name | text | |
homeowner_last_name | text | |
homeowner_name | text | |
id | text | yes |
is_shared | true or false | |
job_id | text | |
knock_position | any | |
knock_result | text | |
knock_result_option | text | |
latitude | number | |
longitude | number | |
notes | text | |
phone | text | |
pin_type | text | |
state | text | |
zip | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_product
Change a product.
| Field | Type | Required |
|---|---|---|
category | text | |
cost | number | |
coverage_per_unit | number | |
default_price | number | |
description | text | |
id | text | yes |
is_active | true or false | |
item_type | one of `regular`, `upgrade` | |
measurement_basis | text | |
name | text | |
sku | text | |
uom | text | |
updated_at | text | |
waste_percent | number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_punch_item
Tick off (or reword) a punch list item.
| Field | Type | Required |
|---|---|---|
id | text | yes |
text | text | |
done_at | text (date-time) | |
file_ids | list of text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_report
Change a saved report.
| Field | Type | Required |
|---|---|---|
id | text | yes |
title | text | |
description | text | |
folder | text | |
spec | object | |
view | object | |
share | one of `me`, `location`, `company` | |
pinned | true or false |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_storm_list
Rename, recolour, reassign or archive a storm list.
| Field | Type | Required |
|---|---|---|
id | text | yes |
name | text | |
color | text | |
assignee_ids | list of text | |
archived_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_supplement_case
Change a supplement case.
| Field | Type | Required |
|---|---|---|
assigned_to | text | |
autopilot | true or false | |
depreciation_deadline | text | |
next_action | text | |
next_action_at | text | |
stage | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_supplement_gap
Change an item in a supplement.
| Field | Type | Required |
|---|---|---|
evidence_file_ids | list of text | |
included | true or false | |
note | text | |
override_qty | number | |
override_unit_price | number | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_supplement_submission
Change a supplement.
| Field | Type | Required |
|---|---|---|
amount_approved | number | |
amount_requested | number | |
carrier_response_raw | text | |
carrier_scope_id | text | |
case_id | text | |
case_version | number | |
cc | list of text | |
closed_at | text | |
email_message_id | text | |
email_thread_id | text | |
followup_count | number | |
id | text | yes |
job_id | text | |
layer | number | |
letter_file_id | text | |
letter_text | text | |
next_followup_at | text | |
notes | text | |
opened_at | text | |
outcome | text | |
package_file_id | text | |
replied_at | text | |
sent_at | text | |
sent_to | list of text | |
shingle_manufacturer | text | |
shingle_product_line | text | |
source | text | |
status | text | |
supplement_items | any | |
total_items | number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_supplier
Change a supplier.
| Field | Type | Required |
|---|---|---|
account_number | text | |
address | text | |
contact_name | text | |
email | text | |
id | text | yes |
is_active | true or false | |
name | text | |
notes | text | |
phone | text | |
updated_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_task
Change a task.
| Field | Type | Required |
|---|---|---|
adjuster_result | text | |
appointment_option | text | |
appointment_type | text | |
assigned_to | text | |
attendee_ids | list of text | |
calendar_event_id | text | |
calendar_id | text | |
completed | true or false | |
completed_at | text | |
contact_id | text | |
customer_reminder | text | |
customer_reminder_sent_at | text | |
description | text | |
done_when | text | |
done_when_stage | text | |
due_date | text | |
duration_minutes | number | |
end_date | text | |
followup_nudge_sent_at | text | |
homeowner_messages | true or false | |
id | text | yes |
job_id | text | |
location | text | |
notification_id | text | |
outcome | text | |
outcome_recorded_at | text | |
priority | text | |
reminder_minutes | number | |
series_id | text | |
title | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_task_series
Change this and the following repeats.
| Field | Type | Required |
|---|---|---|
series_id | text | yes |
from_task_id | text | yes |
changes | object | yes |
{
"input": {
"series_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"from_task_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"changes": {}
}
}update_tasks
Change several tasks.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
changes | object | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"changes": {
"adjuster_result": "adjuster result"
}
}
}update_work_order
Change a work order (crew, day, scope).
| Field | Type | Required |
|---|---|---|
arrival_time | text | |
auto_created | true or false | |
colors | text | |
crew_id | text | |
days | number | |
depends_on | text | |
hoa_status | text | |
homeowner_told_at | text | |
material_order_id | text | |
materials_notes | text | |
permit_status | text | |
photo_items | any | |
position | number | |
required_shots | list of text | |
scope | any | |
scope_note | text | |
site_notes | text | |
source_estimate_id | text | |
squares | number | |
start_date | text | |
status | text | |
sub_company_id | text | |
title | text | |
trade | text | |
trades | list of text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}Money
accrue_job_commission
Work out the commission on a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}answer_eagleview_report_type_change
Approve or decline EagleView's change of report type.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
approve | true or false | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"approve": true
}
}cancel_eagleview_order
Cancel an EagleView order.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}cancel_hover_order
Cancel a Hover capture request.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}charge_saved_payment_method
Charge a saved card.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
saved_method_id | text | yes |
amount_cents | number |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"saved_method_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}create_commission
Add a commission to a job.
| Field | Type | Required |
|---|---|---|
amount | number | |
basis | text | yes |
basis_amount | number | |
company_cut_percent | number | |
earned_share | number | |
flat_amount | number | |
id | text | |
installment | number | |
job_id | text | yes |
note | text | |
owed_when | text | |
rate_percent | number | yes |
role | text | |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
amount | number | yes |
check_number | text | |
date_deposited | text | |
date_received | text | |
date_sent_to_mortgage | text | |
file_id | text | |
id | text | |
import_id | text | |
invoice_id | text | |
is_sample | true or false | |
job_id | text | |
notes | text | |
payer_type | text | |
payment_method | text | |
payment_type | text | yes |
processor | text | |
processor_fee | number | |
processor_reference | text | |
status | text |
{
"input": {
"amount": 1250,
"payment_type": "payment type"
}
}keep_payments_waiting
Keep a file’s unplaced payments waiting for a person.
| Field | Type | Required |
|---|---|---|
processor | text | yes |
rows | list of object | yes |
{
"input": {
"processor": "processor",
"rows": [
{
"processor_reference": "processor reference",
"kind": "payment",
"amount": 1250,
"date_received": "2026-11-19"
}
]
}
}mark_commissions_paid
Mark commissions paid.
| Field | Type | Required |
|---|---|---|
commission_ids | list of text | yes |
{
"input": {
"commission_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}match_material_order_bill
Match the supplier's bill to a material order.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
amount | number | yes |
invoice_number | text | |
file_id | text |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"amount": 1250
}
}pay_commissions
Pay a person's commissions.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
commission_ids | list of text | yes |
note | text |
{
"input": {
"user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"commission_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}record_base_pay
Record base pay.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
amount | number | yes |
period_start | text | yes |
period_end | text | yes |
counts_as_draw | true or false | yes |
occurred_on | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
amount | number | yes |
occurred_on | text | yes |
note | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
import_id | text | yes |
payments | list of object | yes |
refunds | list of object | yes |
{
"input": {
"import_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"payments": [],
"refunds": []
}
}record_payments
Record a check split across payments.
| Field | Type | Required |
|---|---|---|
payments | list of object | yes |
{
"input": {
"payments": [
{
"amount": 1250,
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"payment_type": "payment type"
}
]
}
}record_processor_payment
Record a payment taken through another processor.
| Field | Type | Required |
|---|---|---|
processor | text | yes |
reference | text | yes |
amount | number | yes |
kind | one of `payment`, `refund` | yes |
original_reference | text | |
date | text | |
fee | number | |
method | one of `card`, `ach`, `check`, `cash`, `financing`, `other` | |
deposited | true or false | |
invoice_id | text | |
invoice_number | text | |
job_id | text | |
job_number | text | |
customer_name | text | |
customer_email | text | |
customer_phone | text | |
description | text | |
notes | text |
{
"input": {
"processor": "processor",
"reference": "reference",
"amount": 1250,
"kind": "payment"
}
}refund_payment
Refund a payment.
| Field | Type | Required |
|---|---|---|
payment_id | text | yes |
amount | number | yes |
notes | text | |
date | text | yes |
{
"input": {
"payment_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"amount": 1250,
"date": "2026-11-19"
}
}release_mortgage_draw
Release part of a mortgage check.
| Field | Type | Required |
|---|---|---|
payment_id | text | yes |
amount | number | yes |
date_received | text | yes |
draw_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
base_pay_weekly | number | yes |
base_pay_starts_on | text | yes |
base_pay_is_draw | true or false | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
aside | true or false | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"aside": true
}
}set_record_status
Change the status of an estimate, invoice, contract, order or payment.
| Field | Type | Required |
|---|---|---|
kind | one of `estimate`, `invoice`, `material_order`, `smartdoc`, `payment` | yes |
id | text | yes |
status | text | yes |
{
"input": {
"kind": "estimate",
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"status": "status"
}
}start_payment_import
Start importing payments from a processor’s file.
| Field | Type | Required |
|---|---|---|
id | text | yes |
processor | text | yes |
file_name | text | |
line_count | whole number | yes |
skipped_count | whole number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"processor": "processor",
"line_count": 0
}
}submit_supplier_order
Place an order with the supplier.
| Field | Type | Required |
|---|---|---|
material_order_id | text | yes |
ship_to_number | text | yes |
ship_to_name | text | |
branch_number | text | yes |
delivery_service | text | |
delivery_date_tbd | true or false |
{
"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.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}sync_quickbooks_record
Send a record to QuickBooks.
| Field | Type | Required |
|---|---|---|
entity_type | one of `payment`, `estimate`, `contact`, `job_cost`, `material_order`, `commission_ledger` | yes |
entity_id | text | yes |
{
"input": {
"entity_type": "payment",
"entity_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}undo_invoice_write_off
Undo an invoice write-off.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_owed_commission
Change an owed commission.
| Field | Type | Required |
|---|---|---|
amount | number | |
basis | text | |
basis_amount | number | |
company_cut_percent | number | |
earned_share | number | |
flat_amount | number | |
id | text | yes |
installment | number | |
job_id | text | |
note | text | |
owed_when | text | |
rate_percent | number | |
role | text | |
updated_at | text | |
user_id | text | |
status | one of `owed`, `void` |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_payment
Change a payment.
| Field | Type | Required |
|---|---|---|
amount | number | |
check_number | text | |
date_deposited | text | |
date_received | text | |
date_sent_to_mortgage | text | |
file_id | text | |
id | text | yes |
import_id | text | |
invoice_id | text | |
is_sample | true or false | |
job_id | text | |
notes | text | |
payer_type | text | |
payment_method | text | |
payment_type | text | |
processor | text | |
processor_fee | number | |
processor_reference | text | |
status | text | |
updated_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}waive_invoice_late_fee
Waive the late fee on an invoice.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}write_off_invoice
Write off an invoice.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
custom_message | text | |
subject | text | |
body | text |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}cancel_signing_link
Cancel a homeowner's signing link.
| Field | Type | Required |
|---|---|---|
kind | one of `job_document`, `estimate` | yes |
id | text | yes |
{
"input": {
"kind": "job_document",
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}create_companycam_project
Make a CompanyCam project for a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}export_jobs_to_companycam
Make a CompanyCam project for each picked job.
| Field | Type | Required |
|---|---|---|
job_ids | list of text | yes |
{
"input": {
"job_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}move_jobs_to_stage
Move several jobs to a stage.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
stage | text | yes |
pipeline_id | text | |
date_known | true or false | |
moved_on | text |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"stage": "stage"
}
}queue_stage_followups
Queue a stage rule's later messages.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
contact_id | text | yes |
rule_id | text | yes |
stage_key | text | yes |
now | text |
{
"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.
| Field | Type | Required |
|---|---|---|
request_id | text | yes |
message | text | yes |
screen | text | |
platform | text | |
app_version | text | |
posthog_session_id | text |
{
"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.
| Field | Type | Required |
|---|---|---|
crew_id | text | |
sub_company_id | text | |
kinds | list of one of `insurance`, `workers_comp`, `w9`, `license`, `other` | yes |
note | text | |
body | text | |
from_phone_id | text |
{
"input": {
"kinds": [
"insurance"
]
}
}request_estimate_signature
Send an estimate to be signed.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
signer_email | text | yes |
signer_name | text | yes |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"signer_email": "dana@example.com",
"signer_name": "signer name"
}
}request_link_signature
Set up signing by link.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
signers | list of object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}resume_sms_broadcast
Resume a paused text broadcast.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}run_stage_change_automation
Send a job's stage-change message.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
new_stage | text | yes |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"new_stage": "new stage"
}
}schedule_email
Schedule an email to send later.
| Field | Type | Required |
|---|---|---|
contact_id | text | |
job_id | text | |
send_at | text | yes |
payload | object | yes |
{
"input": {
"send_at": "2026-11-19T15:00:00Z",
"payload": {
"to": [
"to"
],
"subject": "subject",
"body": "body"
}
}
}schedule_text
Schedule a text to send later.
| Field | Type | Required |
|---|---|---|
id | text | yes |
contact_id | text | |
job_id | text | |
to_phone | text | yes |
body | text | yes |
media_urls | list of text | |
send_at | text | yes |
from_phone_id | text | |
kind | one of `payment`, `portal`, `appointment`, `crew`, `review`, `broadcast`, `conversation`, `quote`, `follow_up` |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"to_phone": "+16155550148",
"body": "body",
"send_at": "2026-11-19T15:00:00Z"
}
}send_app_link
Text the HailMate app link to a phone.
| Field | Type | Required |
|---|---|---|
phone | text | yes |
workspace_id | text |
{
"input": {
"phone": "+16155550148"
}
}send_crew_invite
Text a crew person their invite.
| Field | Type | Required |
|---|---|---|
invite_id | text | yes |
body | text | |
from_phone_id | text |
{
"input": {
"invite_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_email
Send an email.
| Field | Type | Required |
|---|---|---|
to | list of text | yes |
cc | list of text | |
bcc | list of text | |
subject | text | yes |
body | text | yes |
body_format | one of `markdown`, `text` | |
quoted_text | text | |
quoted_html | text | |
signature_text | text | |
signature_html | text | |
contact_id | text | |
job_id | text | |
estimate_id | text | |
invoice_id | text | |
supplement_submission_id | text | |
in_reply_to | text | |
thread_id | text | |
ai_drafted | true or false | |
send_as | one of `mailbox`, `workspace` | |
copy_self | true or false | |
attachments | list of object |
{
"input": {
"to": [
"to"
],
"subject": "subject",
"body": "body"
}
}send_estimate_email
Email an estimate.
| Field | Type | Required |
|---|---|---|
estimate_id | text | yes |
recipient_email | text | yes |
recipient_name | text | |
custom_message | text |
{
"input": {
"estimate_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"recipient_email": "dana@example.com"
}
}send_held_message_anyway
Send a held text or email anyway.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_invoice
Email an invoice.
| Field | Type | Required |
|---|---|---|
invoice_id | text | yes |
to | text | yes |
subject | text | |
custom_message | text | |
body | text | |
attachment_name | text |
{
"input": {
"invoice_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"to": "to"
}
}send_invoice_reminders
Send invoice reminders.
| Field | Type | Required |
|---|---|---|
invoice_ids | list of text | yes |
from_phone_id | text |
{
"input": {
"invoice_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}send_job_document_for_signature
Send a job document for signature.
| Field | Type | Required |
|---|---|---|
document_id | text | yes |
signing_method | one of `in_person`, `email` | yes |
signers | list of object | yes |
message | text | |
sign_first | true or false |
{
"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.
| Field | Type | Required |
|---|---|---|
record_ids | list of text | yes |
target_workspace_id | text | yes |
travel | object |
{
"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.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
custom_message | text | |
include_pricing | true or false | |
subject | text | |
body | text | |
attach_csv | true or false |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_payment_receipt
Email a payment receipt.
| Field | Type | Required |
|---|---|---|
payment_id | text | yes |
{
"input": {
"payment_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_queued_message_now
Send a scheduled text now.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_review_request
Text a customer a review request.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
new_stage | text |
{
"input": {
"job_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_sms_message
Send a text.
| Field | Type | Required |
|---|---|---|
contact_id | text | |
contact_phone | text | yes |
body | text | yes |
job_id | text | |
ai_drafted | true or false | |
media_urls | list of text | |
from_phone_id | text | |
kind | one of `payment`, `portal`, `appointment`, `crew`, `review`, `broadcast`, `conversation`, `quote`, `follow_up` |
{
"input": {
"contact_phone": "+16155550148",
"body": "body"
}
}send_supplement_rebuttal
Send the rebuttal to the carrier.
| Field | Type | Required |
|---|---|---|
case_id | text | yes |
body | text |
{
"input": {
"case_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}send_to_sister_workspace
Send a contact or job to a sister company.
| Field | Type | Required |
|---|---|---|
kind | one of `contact`, `job` | yes |
record_id | text | yes |
target_workspace_id | text | yes |
travel | object |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
work_order_id | text | yes |
body | text | yes |
file_ids | list of text | |
language | one of `en`, `es` |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"work_order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"body": ""
}
}start_sms_broadcast
Send a text broadcast.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}submit_support_request
Ask HailMate support for help.
| Field | Type | Required |
|---|---|---|
workspace_id | text | |
message | text | yes |
help_chat_id | text | |
screen | text | |
platform | text | |
app_version | text | |
posthog_session_id | text |
{
"input": {
"message": "message"
}
}tell_supplier_delivery_change
Email the supplier a new delivery day.
| Field | Type | Required |
|---|---|---|
order_id | text | yes |
delivery_date | text | yes |
subject | text | |
body | text | |
reason | one of `rain` |
{
"input": {
"order_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"delivery_date": "2026-11-19"
}
}Setup
add_certification
Add a certification from the catalog.
| Field | Type | Required |
|---|---|---|
certification_program_id | text | yes |
credential_number | text | |
custom_logo_url | text | |
display_order | number |
{
"input": {
"certification_program_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}add_custom_certification
Add a certification of your own.
| Field | Type | Required |
|---|---|---|
organization | text | |
program | text | yes |
badge_label | text | |
credential_number | text | |
custom_logo_url | text | |
display_order | number |
{
"input": {
"program": "program"
}
}add_state_territory
Add a state to the territory.
| Field | Type | Required |
|---|---|---|
label | text | yes |
state_code | text | yes |
{
"input": {
"label": "label",
"state_code": "state code"
}
}apply_commission_setup
Choose how the company pays people.
| Field | Type | Required |
|---|---|---|
setup | one of `reps_do_it_all`, `setters_and_closers`, `hourly_setters` | yes |
owed_when | one of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid` | yes |
sales | object | yes |
canvasser | object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}change_crew_invite_phone
Change an invited crew person's cell.
| Field | Type | Required |
|---|---|---|
invite_id | text | yes |
phone | text | yes |
{
"input": {
"invite_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"phone": "+16155550148"
}
}change_crew_login_phone
Move a crew login to a new cell.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
phone | text | yes |
{
"input": {
"user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"phone": "+16155550148"
}
}complete_companycam_setup
Finish setting up CompanyCam.
It takes no input.
{
"input": {}
}create_boldsign_sender_identity
Set up the address contracts are sent from.
It takes no input.
{
"input": {}
}create_calendar
Add a calendar.
| Field | Type | Required |
|---|---|---|
auto_join_roles | list of text | |
color | text | |
default_for_types | list of text | |
members_see_all | true or false | |
name | text | yes |
id | text | |
member_ids | list of text | yes |
{
"input": {
"name": "name",
"member_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}create_crew
Add a crew.
| Field | Type | Required |
|---|---|---|
active | true or false | |
color | text | |
contact_id | text | |
email | text | |
kind | text | |
name | text | yes |
notes | text | |
phone | text | |
squares_per_day | number | |
sub_company_id | text | |
trades | list of text | |
id | text | |
member_ids | list of text | |
lead_id | text |
{
"input": {
"name": "name"
}
}create_document_template
Create a document template.
| Field | Type | Required |
|---|---|---|
blocks | any | |
description | text | |
doc_type | text | |
id | text | |
name | text | yes |
pdf_form | any |
{
"input": {
"name": "name"
}
}create_export_schedule
Email a report or export on a schedule.
| Field | Type | Required |
|---|---|---|
name | text | yes |
items | list of object | yes |
format | one of `xlsx`, `csv` | yes |
cadence | one of `day`, `week`, `month` | yes |
weekday | whole number | |
month_day | whole number | |
hour | whole number | yes |
time_zone | text | |
deliver_members | list of text | |
deliver_emails | list of text (email) | |
destination_id | text |
{
"input": {
"name": "name",
"items": [
{
"saved_report_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
],
"format": "xlsx",
"cadence": "day",
"hour": 0
}
}create_lead_link
Make a website lead link.
| Field | Type | Required |
|---|---|---|
assigned_to | text | |
kind | text | |
lead_source | text | |
name | text | yes |
pipeline_id | text | |
stage_key | text | |
id | text |
{
"input": {
"name": "name"
}
}create_pipeline
Add a pipeline.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
id | text | |
name | text | yes |
slug | text | yes |
visibility | text | |
visible_roles | list of text |
{
"input": {
"name": "name",
"slug": "slug"
}
}create_pipeline_stage
Add a stage to a pipeline.
| Field | Type | Required |
|---|---|---|
color | text | |
display_order | number | |
hidden_from_roles | list of text | |
hold_until_tasks_done | true or false | |
id | text | |
is_completed | true or false | |
is_lost | true or false | |
label | text | yes |
milestone | text | |
pipeline_id | text | yes |
stage_key | text | yes |
stage_people_stay | true or false |
{
"input": {
"label": "label",
"pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"stage_key": "stage key"
}
}create_rep_territory
Draw a rep territory.
| Field | Type | Required |
|---|---|---|
name | text | yes |
color | text | yes |
ring | list of object | yes |
assignee_ids | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
id | text | |
items | any | |
name | text | yes |
price_per_square | number | |
starter_key | text |
{
"input": {
"name": "name"
}
}create_sub_company
Add a subcontractor company.
| Field | Type | Required |
|---|---|---|
active | true or false | |
language | text | |
name | text | yes |
notes | text | |
owner_name | text | |
owner_phone | text | |
id | text |
{
"input": {
"name": "name"
}
}create_workflow
Create an automation.
| Field | Type | Required |
|---|---|---|
actions | any | yes |
conditions | any | yes |
description | text | yes |
enabled | true or false | yes |
id | text | |
name | text | yes |
trigger | any | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
crew_id | text | yes |
is_lead | true or false | yes |
language | one of `en`, `es` | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"is_lead": false,
"language": "en"
}
}dismiss_imported_person
Dismiss an imported person.
| Field | Type | Required |
|---|---|---|
person_id | text | yes |
{
"input": {
"person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}give_imported_jobs
Give imported jobs to a teammate.
| Field | Type | Required |
|---|---|---|
person_id | text | yes |
user_id | text | yes |
limit | whole number | yes |
{
"input": {
"person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"user_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"limit": 100
}
}link_imported_person
Link an imported person to a teammate by email.
| Field | Type | Required |
|---|---|---|
person_id | text | yes |
email | text | yes |
{
"input": {
"person_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"email": "dana@example.com"
}
}link_sister_job
Link a job to the same job in a sister company.
| Field | Type | Required |
|---|---|---|
record_id | text | yes |
target_record_id | text | yes |
choices | object |
{
"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.
| Field | Type | Required |
|---|---|---|
stage_id | text | yes |
{
"input": {
"stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_leaderboard_goal
Take a leaderboard goal away.
| Field | Type | Required |
|---|---|---|
metric | one of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value` | yes |
{
"input": {
"metric": "doors"
}
}rename_company_document
Rename a company document.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
name | text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"name": "name"
}
}renew_lead_link_token
Give a website lead link a new address.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}renew_showcase_link
Give the showcase page a new address.
| Field | Type | Required |
|---|---|---|
share_token | text |
{
"input": {
"share_token": "share token"
}
}reorder_calendars
Put the calendars in a new order.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}reorder_pipeline_stages
Put a pipeline's stages in a new order.
| Field | Type | Required |
|---|---|---|
stages | list of object | yes |
{
"input": {
"stages": [
{
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"display_order": -9007199254740991
}
]
}
}replace_commission_rates
Change the rates on a commission plan.
| Field | Type | Required |
|---|---|---|
rule_id | text | |
setter_rule_id | text | |
rates | list of object | yes |
{
"input": {
"rates": [
{
"lead_source": "lead source",
"job_type": "insurance",
"rate_percent": 1
}
]
}
}reset_message_template
Put an automatic message back to the standard wording.
| Field | Type | Required |
|---|---|---|
template_key | text | yes |
{
"input": {
"template_key": "template key"
}
}resolve_job_access_request
Add someone to a job, or not now.
| Field | Type | Required |
|---|---|---|
request_id | text | yes |
add | true or false | yes |
{
"input": {
"request_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"add": true
}
}revoke_live_link
Turn off a live link.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}save_checklist_template
Save a company checklist.
| Field | Type | Required |
|---|---|---|
id | text | |
name | text | yes |
items | list of object | yes |
auto_add_stage_ids | list of text | yes |
required_stage_ids | list of text | |
starter_key | text | |
position | whole number |
{
"input": {
"name": "name",
"items": [
{}
],
"auto_add_stage_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}save_commission_rule
Save a commission plan.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
rate_percent | number | yes |
flat_amount | number | yes |
basis | text | yes |
is_active | true or false | yes |
company_cut_percent | number | |
owed_when | one of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid` |
{
"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.
| Field | Type | Required |
|---|---|---|
user_id | text | yes |
rate_percent | number | yes |
flat_amount | number | yes |
basis | text | yes |
is_active | true or false | yes |
company_cut_percent | number | |
owed_when | one of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid` |
{
"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.
| Field | Type | Required |
|---|---|---|
owed_when | one of `contract_signed`, `job_completed`, `paid_in_full`, `as_paid` | yes |
setup | one of `reps_do_it_all`, `setters_and_closers`, `hourly_setters` |
{
"input": {
"owed_when": "contract_signed"
}
}save_crew_invite
Add a person to a crew by name and cell.
| Field | Type | Required |
|---|---|---|
kind | one of `member`, `sub_owner` | yes |
crew_id | text | |
sub_company_id | text | |
name | text | yes |
phone | text | yes |
is_lead | true or false | yes |
language | one of `en`, `es` | yes |
work_order_id | text |
{
"input": {
"kind": "member",
"name": "name",
"phone": "+16155550148",
"is_lead": false,
"language": "en"
}
}save_crew_rate
Set a line on a crew's rate card.
| Field | Type | Required |
|---|---|---|
id | text | |
crew_id | text | yes |
label | text | yes |
unit | one of `sq`, `steep_sq`, `layer_sq`, `each`, `lf`, `sheet`, `day`, `hour`, `job` | yes |
rate | number | yes |
position | whole number |
{
"input": {
"crew_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"label": "label",
"unit": "sq",
"rate": 0
}
}save_estimate_settings
Save the estimate defaults.
| Field | Type | Required |
|---|---|---|
auto_draft_estimates | true or false | |
boldsign_synced_name | text | |
company_insurance_info | text | |
company_license_number | text | |
default_cost_per_square | number | |
default_labor_cost_per_square | number | |
default_material_cost_per_square | number | |
default_price_per_square | number | |
default_tax_rate | number | |
default_templates | any | |
default_terms_and_conditions | text | |
default_valid_days | number | |
deposit_percent | number | |
extra_layer_per_square | number | |
extra_story_per_square | number | |
invoice_default_due_days | number | |
invoice_default_notes | text | |
invoice_default_tax_rate | number | |
invoice_default_terms | text | |
min_margin_percent | number | |
pdf_primary_color | text | |
steep_pitch_from | number | |
steep_pitch_per_square | number |
{
"input": {
"auto_draft_estimates": true
}
}save_inspection_template
Save a photo checklist.
| Field | Type | Required |
|---|---|---|
id | text | |
name | text | yes |
description | text | |
items | list of object | yes |
rules | list of text | |
based_on | text |
{
"input": {
"name": "name",
"items": [
{}
]
}
}save_job_role_settings
Choose which roles the company uses on its jobs.
| Field | Type | Required |
|---|---|---|
canvasser_on | true or false | |
project_manager_on | true or false |
{
"input": {
"canvasser_on": true
}
}save_leaderboard_goal
Set a leaderboard goal.
| Field | Type | Required |
|---|---|---|
metric | one of `doors`, `talked`, `appointments`, `found`, `sold`, `sold_value` | yes |
per | one of `day`, `week`, `month` | yes |
target | number | yes |
{
"input": {
"metric": "doors",
"per": "day",
"target": 1
}
}save_location_settings
Change the team map settings.
| Field | Type | Required |
|---|---|---|
team_map | true or false | |
knock_check_feet | whole number |
{
"input": {
"team_map": true
}
}save_message_template
Save the wording of an automatic message.
| Field | Type | Required |
|---|---|---|
template_key | text | yes |
subject | text | |
body | text | |
enabled | true or false |
{
"input": {
"template_key": "template key"
}
}save_money_targets
Set the company's monthly goals and overhead.
| Field | Type | Required |
|---|---|---|
monthly_collected_goal | number | yes |
monthly_sold_goal | number | yes |
monthly_overhead | number | yes |
{
"input": {
"monthly_collected_goal": 0,
"monthly_sold_goal": 0,
"monthly_overhead": 0
}
}save_payment_import_profile
Remember how a processor’s file is read.
| Field | Type | Required |
|---|---|---|
header_signature | text | yes |
processor | text | yes |
mapping | object | yes |
defaults | object |
{
"input": {
"header_signature": "header signature",
"processor": "processor",
"mapping": {}
}
}save_showcase_settings
Change the showcase page.
| Field | Type | Required |
|---|---|---|
published | true or false | |
headline | text | |
intro | text |
{
"input": {
"published": true
}
}save_workspace_automation
Save an automation setting.
| Field | Type | Required |
|---|---|---|
type | one of `stage_change`, `missed_call_text_back`, `invoice_overdue`, `review_request`, `stage_task`, `job_timer`, `appointment` | yes |
enabled | true or false | yes |
config | object | yes |
managed_keys | list of text |
{
"input": {
"type": "stage_change",
"enabled": true,
"config": {}
}
}set_appointment_length
Set how long a kind of appointment takes.
| Field | Type | Required |
|---|---|---|
appointment_type | one of `appointment`, `adjuster_meeting`, `inspection`, `build_day` | yes |
duration_minutes | whole number | yes |
{
"input": {
"appointment_type": "appointment",
"duration_minutes": 15
}
}set_calendar_members
Choose who is on a calendar.
| Field | Type | Required |
|---|---|---|
id | text | yes |
member_ids | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
template_id | text | yes |
stage_id | text | yes |
on | true or false | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
template_id | text | yes |
stage_id | text | yes |
on | true or false | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
pipeline_id | text | yes |
{
"input": {
"pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}set_default_stage
Choose the stage new jobs start in.
| Field | Type | Required |
|---|---|---|
pipeline_id | text | yes |
stage_id | text | yes |
{
"input": {
"pipeline_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"stage_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}set_job_setter
Choose who set a job.
| Field | Type | Required |
|---|---|---|
job_id | text | yes |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
archived | true or false | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"archived": true
}
}set_stage_people
Choose who works a column.
| Field | Type | Required |
|---|---|---|
stage_id | text | yes |
user_ids | list of text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
stage_ids | list of text | yes |
roles | list of text | yes |
{
"input": {
"stage_ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
],
"roles": [
"role"
]
}
}set_workflow_enabled
Switch an automation on or off.
| Field | Type | Required |
|---|---|---|
id | text | yes |
enabled | true or false | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc",
"enabled": true
}
}start_companycam_connection
Start connecting CompanyCam.
It takes no input.
{
"input": {}
}switch_state_territory
Change a state in the territory.
| Field | Type | Required |
|---|---|---|
territory_id | text | yes |
state_code | text | yes |
apply | true or false | yes |
{
"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.
{
"input": {}
}unlink_sister_record
Stop sharing a contact or job with sister companies.
| Field | Type | Required |
|---|---|---|
kind | one of `contact`, `job` | yes |
record_id | text | yes |
{
"input": {
"kind": "contact",
"record_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_calendar
Change a calendar.
| Field | Type | Required |
|---|---|---|
auto_join_roles | list of text | |
color | text | |
default_for_types | list of text | |
members_see_all | true or false | |
name | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_certification
Change a certification.
| Field | Type | Required |
|---|---|---|
id | text | yes |
credential_number | text | |
custom_logo_url | text | |
display_order | number |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_companycam_settings
Change the CompanyCam sync settings.
| Field | Type | Required |
|---|---|---|
settings | object | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
active | true or false | |
color | text | |
contact_id | text | |
email | text | |
kind | text | |
name | text | |
notes | text | |
phone | text | |
squares_per_day | number | |
sub_company_id | text | |
trades | list of text | |
id | text | yes |
member_ids | list of text | |
lead_id | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_document_template
Change a document template.
| Field | Type | Required |
|---|---|---|
blocks | any | |
description | text | |
doc_type | text | |
id | text | yes |
name | text | |
pdf_form | any | |
updated_at | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_export_schedule
Change a scheduled export.
| Field | Type | Required |
|---|---|---|
id | text | yes |
name | text | |
items | list of object | |
format | one of `xlsx`, `csv` | |
cadence | one of `day`, `week`, `month` | |
weekday | whole number | |
month_day | whole number | |
hour | whole number | |
time_zone | text | |
deliver_members | list of text | |
deliver_emails | list of text (email) | |
destination_id | text | |
paused | true or false |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_lead_link
Change a website lead link.
| Field | Type | Required |
|---|---|---|
assigned_to | text | |
enabled | true or false | |
kind | text | |
lead_source | text | |
name | text | |
pipeline_id | text | |
price_page | true or false | |
stage_key | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_pipeline
Change a pipeline.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
name | text | |
slug | text | |
visibility | text | |
visible_roles | list of text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_pipeline_stage
Change a stage.
| Field | Type | Required |
|---|---|---|
color | text | |
display_order | number | |
hidden_from_roles | list of text | |
hold_until_tasks_done | true or false | |
is_completed | true or false | |
is_lost | true or false | |
label | text | |
milestone | text | |
stage_key | text | |
stage_people_stay | true or false | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_quickbooks_sync_settings
Read or change the QuickBooks sync switches.
| Field | Type | Required |
|---|---|---|
auto_push | true or false | |
pull_payments | true or false | |
map_products | true or false |
{
"input": {
"auto_push": true
}
}update_rep_territory
Change a rep territory.
| Field | Type | Required |
|---|---|---|
id | text | yes |
name | text | |
color | text | |
ring | list of object | |
assignee_ids | list of text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_saved_pricing_package
Change a saved pricing package.
| Field | Type | Required |
|---|---|---|
description | text | |
display_order | number | |
items | any | |
name | text | |
price_per_square | number | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_sub_company
Change a subcontractor company.
| Field | Type | Required |
|---|---|---|
active | true or false | |
language | text | |
name | text | |
notes | text | |
owner_name | text | |
owner_phone | text | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_voicemail_settings
Change your voicemail greeting.
| Field | Type | Required |
|---|---|---|
phone_id | text | yes |
enabled | true or false | |
greeting_text | text | |
max_length_seconds | whole number |
{
"input": {
"phone_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}update_workflow
Change an automation.
| Field | Type | Required |
|---|---|---|
actions | any | |
conditions | any | |
description | text | |
enabled | true or false | |
name | text | |
trigger | any | |
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}Deleting
cancel_crew_invite
Cancel a crew invite.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_calendar
Delete a calendar.
| Field | Type | Required |
|---|---|---|
id | text | yes |
move_to | text |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_carrier_scope
Delete a carrier's estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_checklist_template
Delete a company checklist.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_commission_rule
Delete a commission plan.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_commission_setter_rule
Delete a setter commission plan.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_communication_log
Delete a logged email, text or call.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_company_document
Delete a company document.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_contact
Delete a contact.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_contacts
Delete several contacts.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_crew
Remove a crew.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_document_template
Delete a document template.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_email_draft
Delete an email draft.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_email_signature
Delete an email signature.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_email_template
Delete an email template.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimate
Delete an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimate_line_item
Delete a line of an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimate_pricing_package
Remove a pricing option from an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimate_section
Delete a section of an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimate_warranty_option
Remove a warranty option from an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_estimates
Delete several estimates.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_export_schedule
Stop a scheduled export.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_inspection
Delete an inspection.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_invoice
Delete an invoice.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_job
Delete a job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_job_checklist_item
Take an item off a job's checklist.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_job_cost
Delete a job cost.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_job_document
Delete a job document.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_job_documents
Delete several job documents.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_job_file
Delete a file or photo.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_jobs
Delete several jobs.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_lead_link
Delete a website lead link.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_leaderboard_contest
Delete a leaderboard contest.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_material_order
Delete a material order.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_material_order_template
Delete an order template.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_measurement
Delete a job's roof measurement.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_note
Delete a note.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_notification
Delete a notification.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_payment
Delete a payment.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_photo_comment
Delete a photo comment.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_photo_gallery
Delete a photo share link.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_photo_report_template
Delete a photo report layout.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_pin
Delete a pin.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_pin_photo
Delete a pin photo.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_pipeline
Delete a pipeline.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_pipeline_stage
Delete a stage.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_product
Delete a product.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_read_notifications
Clear all read notifications.
It takes no input.
{
"input": {}
}delete_rep_territory
Delete a rep territory.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_report
Delete a saved report.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_saved_pricing_package
Delete a saved pricing package.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_scheduled_email
Clear a cancelled or failed scheduled email.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_sms_broadcast
Delete a draft text broadcast.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_storm_list
Delete a storm list.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_supplement_hand_item
Remove an item added by hand.
| Field | Type | Required |
|---|---|---|
gap_id | text | yes |
{
"input": {
"gap_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_supplement_submission
Delete a supplement.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_supplier
Delete a supplier.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_task
Delete a task.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_tasks
Delete several tasks.
| Field | Type | Required |
|---|---|---|
ids | list of text | yes |
{
"input": {
"ids": [
"3f2a9c1e-77aa-4b2b-9e00-123456789abc"
]
}
}delete_territory
Remove a state from the territory.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_work_order
Delete a work order.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}delete_workflow
Delete an automation.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}end_task_series
Delete this and the following repeats.
| Field | Type | Required |
|---|---|---|
series_id | text | yes |
from_task_id | text | yes |
after | true or false |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}purge_deleted_media
Delete a photo or file for good.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_certification
Remove a certification.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_commission_ledger_entry
Take back a draw or base pay entry.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_crew_day_off
Take a crew's day off back.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_crew_document
Remove a crew's paper.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_crew_person
Take somebody off a crew.
| Field | Type | Required |
|---|---|---|
crew_id | text | yes |
user_id | text | yes |
{
"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.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_estimate_photo
Remove a photo or document from an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_estimate_signer
Remove a signer from an estimate.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_job_person
Take someone off a job.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_punch_item
Take an item off a punch list.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_sub_company
Remove a subcontractor company.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}remove_work_order_log
Remove a daily log entry.
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}reset_inspection_template
Delete a photo checklist (or put back HailMate's).
| Field | Type | Required |
|---|---|---|
id | text | yes |
{
"input": {
"id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}undo_import_run
Undo an import.
| Field | Type | Required |
|---|---|---|
run_id | text | yes |
{
"input": {
"run_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}undo_payment_import
Undo a payment import.
| Field | Type | Required |
|---|---|---|
import_id | text | yes |
{
"input": {
"import_id": "3f2a9c1e-77aa-4b2b-9e00-123456789abc"
}
}Keep reading