Skip to content

Integration · Field service

getcleanops.com

Connect Claude & ChatGPT to CleanOps

Ask your AI what jobs are scheduled this week, which invoices are unpaid, or to quote a new customer in CleanOps. It can create and update customers, leads, jobs, quotes and invoices, assign jobs to your technicians, add internal notes and send quotes and invoices to customers. You get answers about jobs and invoices without clicking through CleanOps.

Connect CleanOps free

Free plan, no credit card. Takes about a minute.

Try asking

  • “Which jobs are scheduled for this week?”

    The AI searches jobs with status scheduled in this week's date range and lists them with customer, address and time.

  • “Book a 3-hour deep clean for Anna Holm on Friday at 9 and assign it to Lars.”

    It finds the customer and the employee, then creates the job with the schedule and assignee. You can have it skip customer notifications.

  • “Quote Nordic Office ApS for weekly office cleaning, 4 hours at 450 DKK.”

    It finds or creates the customer and creates a quote with the line item. It sends the quote only when you ask.

What your AI can do

Jobs and scheduling

Search, create and update jobs with schedule, address and assigned technicians, add job notes and mark jobs completed.

Quotes and invoices

Create, update and send quotes and invoices, and find unpaid or overdue invoices by status, customer or date.

Customers and leads

Search, create and update customers and leads, add internal notes, and convert a lead into a customer.

  • “Which invoices are unpaid?”

    It searches invoices by status and lists the unpaid and overdue ones with customer, amount and due date.

  • “Mark today's job at Strandvejen 12 as completed.”

    It finds the job and marks it completed, with any completion notes you give.

  • “Add a lead from this phone call and convert it to a customer when they say yes.”

    It creates the lead with contact details, source and notes, and later converts the lead into a customer.

490 tools for CleanOps

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

  • add_customer_noteChanges dataAdd an internal note to a customer by `customer_id` with the note `body`.
  • add_job_noteChanges dataAdd an internal note to a job by `job_id` with `note_text`.
  • add_lead_noteChanges dataAdd an internal note to a lead by `lead_id` with `note_text`.
  • approve_avatarVisible to othersConfirm a avatar. Has effects visible outside this system. API summary: Confirm avatar upload.
  • approve_logoVisible to othersConfirm a logo. Has effects visible outside this system. API summary: Confirm logo upload.
  • approve_pdfVisible to othersConfirm a pdf (kind). Has effects visible outside this system. API summary: Confirm a waiver/disclaimer PDF upload.
  • approve_quoteVisible to othersAccept a quote (estimate id). Has effects visible outside this system. API summary: Accept an estimate (public).
  • approve_service_requestVisible to othersApprove a service request (service request id). Has effects visible outside this system.
  • approve_submissionVisible to othersApprove a submission (submission id). Has effects visible outside this system.
  • archive_a_marketing_campaignVisible to othersArchive a campaign (campaign id). Has effects visible outside this system. API summary: Archive a marketing campaign.
  • archive_a_public_formVisible to othersArchive a public form (public form id). Has effects visible outside this system.
  • archive_a_quoteVisible to othersArchive a quote (quote id). Has effects visible outside this system.
  • archive_campaignVisible to othersDisable a campaign (campaign id). Has effects visible outside this system. API summary: Disable an automation campaign and skip its queued runs.
  • archive_customerVisible to othersArchive a customer (customer id). Has effects visible outside this system.
  • archive_expenseVisible to othersArchive a expense (expense id). Has effects visible outside this system. API summary: Archive expense.
  • archive_invoiceVisible to othersArchive a invoice (invoice id). Has effects visible outside this system. API summary: Archive an invoice.
  • archive_packageVisible to othersArchive a package (maintenance package id). Has effects visible outside this system. API summary: Archive a maintenance package.
  • archive_projectVisible to othersArchive a project (job id). Has effects visible outside this system. API summary: Archive a job.
  • archive_promo_codeVisible to othersDisable a promo code (promo code id). Has effects visible outside this system. API summary: State transition: disable.
  • archive_promo_code_archiveVisible to othersArchive a promo code (promo code id). Has effects visible outside this system. API summary: State transition: archive.
  • archive_public_formVisible to othersDisable a public form (public form id). Has effects visible outside this system.
  • archive_quoteVisible to othersArchive a quote (estimate id). Has effects visible outside this system. API summary: Archive an estimate.
  • archive_segmentVisible to othersArchive a segment (segment id). Has effects visible outside this system. API summary: Archive a segment (soft delete).
  • archive_service_requestVisible to othersArchive a service request (service request id). Has effects visible outside this system.
  • archive_templateVisible to othersArchive a template (template id). Has effects visible outside this system.
  • cancel_campaignDeletesCancel a campaign (campaign id). Destructive action; may require approval. API summary: Cancel a scheduled marketing campaign.
  • cancel_pending_downgradeMoves moneyPermanently delete a subscription. Financial or irreversible action; may require approval. API summary: Cancel pending downgrade.
  • cancel_subscriptionDeletesCancel a subscription (maintenance plan id). Destructive action; may require approval. API summary: Cancel a maintenance plan.
  • complete_jobVisible to othersMark a job as completed by `job_id`, with optional completion_notes and actual_end_time.
  • convert_lead_to_customerChanges dataConvert a lead into a customer by `lead_id`.
  • create_a_lead_sourceChanges dataCreate a new lead. Required: name. Search leads first to avoid duplicates. API summary: Create a lead source.
  • create_announcement_acknowledgeChanges dataCreate a new acknowledge for a announcement. API summary: Acknowledge an announcement.
  • create_appleChanges dataCreate a new apple. Required: identity token. API summary: Authenticate with Apple.
  • create_booster_checkoutChanges dataCreate a new booster checkout. Required: tier. API summary: Create a Stripe Checkout Session for a marketing booster purchase.
  • create_campaignChanges dataCreate a new campaign. Required: campaign. Search campaigns first to avoid duplicates. API summary: Create a marketing campaign (draft).
  • create_campaign_pauseChanges dataCreate a new pause for a campaign. API summary: Pause an active automation campaign.
  • create_campaign_resumeChanges dataCreate a new resume for a campaign. API summary: Resume a paused automation campaign.
  • create_checkoutChanges dataCreate a new checkout. Required: plan type. API summary: Create Stripe checkout session.
  • create_connectChanges dataCreate a new connect. API summary: Start Stripe Connect onboarding.
  • create_connect_companycam_connectChanges dataCreate a new connect. API summary: Connect CompanyCam.
  • create_contactChanges dataCreate a new contact. Required: email, message or name. API summary: Submit contact form.
  • create_customerChanges dataCreate a customer with full_name and email (required), plus company_name, phone_number, type and customer_addresses. Search first to avoid duplicates.
  • create_customer_2Changes dataCreate a new customer. Required: content type or filename. Search customers first to avoid duplicates. API summary: Presign a customer-note photo upload.
  • create_customer_addressChanges dataCreate a new address for a customer. Required: address. API summary: Create a saved customer address.
  • create_customer_customer_note_photo_discardChanges dataCreate a new customer. Required: object key. Search customers first to avoid duplicates. API summary: Discard a staged customer-note photo.
  • create_customer_expense_presign_mediaChanges dataCreate a new customer. Required: content type or filename. Search customers first to avoid duplicates. API summary: Presign media upload.
  • create_customer_integrations_qbo_push_customersChanges dataCreate a new customer. Required: ids. Search customers first to avoid duplicates. API summary: Push selected customers to QBO.
  • create_customer_job_presign_photoChanges dataCreate a new customer. Required: content type, filename or kind. Search customers first to avoid duplicates. API summary: Get presigned URL for photo upload.
  • create_customer_portal_invitation_get_linkVisible to othersCreate a new customer for a customer. Search customers first to avoid duplicates. Has effects visible outside this system. API summary: Create customer portal invitation (get link).
  • create_customer_user_profile_switch_customerChanges dataCreate a new customer. Required: customer id. Search customers first to avoid duplicates. API summary: Switch to a different customer account.
  • create_disclaimerChanges dataCreate a new disclaimer. API summary: Accept disclaimers for quote.
  • create_disconnectChanges dataCreate a new disconnect. API summary: Disconnect Zapier.
  • create_disconnect_companycam_disconnectChanges dataCreate a new disconnect. API summary: Disconnect CompanyCam.
  • create_disconnect_integrations_gcal_disconnectChanges dataCreate a new disconnect. API summary: Disconnect Google Calendar.
  • create_disconnect_integrations_qbo_disconnectChanges dataCreate a new disconnect. API summary: Disconnect QuickBooks Online.
  • create_disconnect_integrations_stripe_disconnectChanges dataCreate a new disconnect. API summary: Disconnect Stripe account.
  • create_employeeChanges dataCreate a new employee. Required: email, first name or last name. API summary: Create employee invitation.
  • create_expenseChanges dataCreate a new expense. Required: amount, category id or date of expense. Search expenses first to avoid duplicates. API summary: Create expense.
  • create_expense_mediumVisible to othersCreate a new medium for a expense. Required: byte size, content type, filename or storage key. Has effects visible outside this system. API summary: Finalize media upload.
  • create_feedbackVisible to othersCreate a new feedback. Has effects visible outside this system. API summary: Submit cancellation or downgrade feedback.
  • create_finish_manual_syncChanges dataCreate a new finish manual sync. API summary: Mark manual sync as complete.
  • create_fix_syncChanges dataCreate a new fix sync. Required: customer ids, invoice ids or source. API summary: Apply fix sync to selected items.
  • create_follow_upChanges dataCreate a new follow up. Required: send after unit, send after value or type. API summary: Create a follow-up.
  • create_follow_up_job_schedule_follow_upChanges dataCreate a new follow up. Required: channel, message, send after unit, send after value or trigger. API summary: Schedule a follow-up for a job.
  • create_follow_up_rule_reset_templateChanges dataCreate a new reset template for a follow up rule. API summary: Reset follow-up template to default.
  • create_forgot_passwordDeletesCreate a new forgot password. Required: email. Destructive action; may require approval. API summary: Request password reset.
  • create_generateChanges dataCreate a new generate. API summary: Generate a unique promo code string.
  • create_googleChanges dataCreate a new google. Required: code or redirect uri. API summary: Authenticate with Google.
  • create_invoiceChanges dataCreate an invoice: customer_id, invoice_date, due_date and line_items (description, quantity, unit_price) required, plus job_id, tax, discounts, notes and include_payment_link.
  • create_invoice_2Changes dataCreate a new invoice. Required: ids. Search invoices first to avoid duplicates. API summary: Push selected invoices to QBO.
  • create_invoice_invoice_apply_promoChanges dataCreate a new invoice for a invoice. Required: code. Search invoices first to avoid duplicates. API summary: Apply a promo code to an invoice.
  • create_invoice_invoice_change_statusChanges dataCreate a new invoice for a invoice. Required: status. Search invoices first to avoid duplicates. API summary: Change invoice status.
  • create_invoice_paymentChanges dataCreate a new payment for a invoice. API summary: Get Stripe payment link for invoice.
  • create_invoice_record_viewChanges dataCreate a new record view for a invoice. API summary: Record first view of invoice.
  • create_invoice_revoke_linkChanges dataCreate a new revoke link for a invoice. API summary: Revoke a invoice public link.
  • create_invoice_rotate_linkChanges dataCreate a new rotate link for a invoice. API summary: Replace a invoice public link.
  • create_jobChanges dataCreate a job for a customer_id (required) with description, address, status, scheduled_start_time and duration_hours (or scheduled_dates for multi-day jobs), assigned_to_id and quote_id. May notify the customer unless suppress_notifications is true.
  • create_leadChanges dataCreate a lead with name (required), email, phone_number, address, lead_source, lead_status, tags, notes, next_action and next_step_date.
  • create_lead_2Changes dataCreate a new lead for a lead. Required: event type or scheduled at. Search leads first to avoid duplicates. API summary: Schedule an event on a lead.
  • create_lead_api_lead_source_reorderChanges dataCreate a new lead. Required: ordered ids. Search leads first to avoid duplicates. API summary: Reorder lead sources.
  • create_lead_quoteChanges dataCreate a new quote for a lead. Search quotes first to avoid duplicates. API summary: Create an estimate on a lead.
  • create_notification_template_resetChanges dataCreate a new reset for a notification template. API summary: Reset template to default.
  • create_packageChanges dataCreate a new package. Search packages first to avoid duplicates. API summary: Create a maintenance package.
  • create_portalChanges dataCreate a new portal. API summary: Create Stripe billing portal session.
  • create_pricing_templateChanges dataCreate a new pricing template. Required: complexity, cost per unit, surface type or unit. API summary: Create a pricing template.
  • create_projectChanges dataCreate a new project for a project. Search projects first to avoid duplicates. API summary: Notify customer the technician is on the way.
  • create_project_clock_inChanges dataCreate a new clock in for a project. API summary: Clock in to a job.
  • create_project_clock_outChanges dataCreate a new clock out for a project. API summary: Clock out from a job.
  • create_project_feedbackChanges dataCreate a new feedback for a project. Required: rating. API summary: Create customer feedback for a job.
  • create_project_job_change_statusChanges dataCreate a new project for a project. Required: status. Search projects first to avoid duplicates. API summary: Change job status.
  • create_project_photoChanges dataCreate a new photo for a project. Required: byte size, content type, filename, kind or object key. API summary: Finalize photo upload.
  • create_project_revoke_linkChanges dataCreate a new revoke link for a project. API summary: Revoke a job public link.
  • create_project_rotate_linkChanges dataCreate a new rotate link for a project. API summary: Replace a job public link.
  • create_promo_codeChanges dataCreate a new promo code. Required: promo code. Search promo codes first to avoid duplicates. API summary: Create a Marketing promo code.
  • create_promo_code_end_nowChanges dataCreate a new end now for a promo code. API summary: State transition: endnow.
  • create_promo_code_resumeChanges dataCreate a new resume for a promo code. API summary: State transition: resume.
  • create_public_formChanges dataCreate a new public form. Required: kind or name. Search public forms first to avoid duplicates. API summary: Create a public form.
  • create_public_form_revoke_tokenDeletesCreate a new revoke token for a public form. Destructive action; may require approval. API summary: Revoke a public form's token.
  • create_public_form_rotate_tokenDeletesCreate a new rotate token for a public form. Destructive action; may require approval. API summary: Rotate a public form's token.
  • create_quoteChanges dataCreate a quote for a customer: customer_id and line_items (description, quantity, unit_price) required, plus address, tax, discounts, notes and require_signature.
  • create_quote_2Changes dataCreate a new quote for a quote. Search quotes first to avoid duplicates. API summary: Create a maintenance plan from a quote.
  • create_quote_estimate_change_statusChanges dataCreate a new quote for a quote. Required: status. Search quotes first to avoid duplicates. API summary: Change an estimate's status.
  • create_quote_estimate_convertChanges dataCreate a new quote for a quote. Search quotes first to avoid duplicates. API summary: Convert an estimate to a quote.
  • create_quote_quote_apply_promoChanges dataCreate a new quote for a quote. Required: code. Search quotes first to avoid duplicates. API summary: Apply a promo code to a quote.
  • create_quote_quote_change_statusChanges dataCreate a new quote for a quote. Required: status. Search quotes first to avoid duplicates. API summary: Change quote status.
  • create_quote_quote_signatureChanges dataCreate a new quote for a quote. Required: signature mode or signed name. Search quotes first to avoid duplicates. API summary: Capture an electronic signature on a quote.
  • create_quote_record_viewChanges dataCreate a new record view for a quote. API summary: Record first view of quote.
  • create_quote_revoke_linkChanges dataCreate a new revoke link for a quote. API summary: Revoke a quote public link.
  • create_quote_revoke_link_estimate_revoke_public_linkChanges dataCreate a new revoke link for a quote. API summary: Revoke a estimate public link.
  • create_quote_rotate_linkChanges dataCreate a new rotate link for a quote. API summary: Replace a quote public link.
  • create_reconnectChanges dataCreate a new reconnect. Required: choice. API summary: Handle QBO reconnect choice.
  • create_registerChanges dataCreate a new register. Required: email or password. API summary: Register new user.
  • create_reminderChanges dataCreate a new reminder. Required: job id or scheduled at. API summary: Create a reminder.
  • create_reminder_job_schedule_reminderChanges dataCreate a new reminder. Required: audience, channel, message, send after unit, send after value or trigger. API summary: Schedule a reminder for a job.
  • create_reminder_rule_reset_templateChanges dataCreate a new reset template for a reminder rule. API summary: Reset reminder template to default.
  • create_resetChanges dataCreate a new reset. API summary: Reset brand colors to defaults.
  • create_reset_passwordDeletesCreate a new reset password. Required: password or token. Destructive action; may require approval. API summary: Reset password with token.
  • create_rotateChanges dataCreate a new rotate. API summary: Rotate the combined intake link.
  • create_segmentChanges dataCreate a new segment. Required: segment. Search segments first to avoid duplicates. API summary: Create a segment.
  • create_service_requestChanges dataCreate a new service request. Required: customer id. Search service requests first to avoid duplicates. API summary: Create a service request.
  • create_service_request_change_statusChanges dataCreate a new change status for a service request. Required: status. API summary: Change service request status.
  • create_service_request_photoChanges dataCreate a new photo for a service request. Required: byte size, content type, filename or object key. API summary: Finalize photo upload.
  • create_sms_consentVisible to othersCreate a new sms consent. Required: consent type. Has effects visible outside this system. API summary: Grant SMS consent.
  • create_sms_consent_notification_preferences_grant_sms_consentVisible to othersCreate a new sms consent. Has effects visible outside this system. API summary: Grant SMS consent for notifications.
  • create_subscriptionChanges dataCreate a new subscription. Required: billing method, customer id, frequency, name, package id or start date. API summary: Create a maintenance plan.
  • create_subscription_billing_portal_sessionChanges dataCreate a new billing portal session for a subscription. API summary: Create a Stripe Billing Portal session.
  • create_subscription_pauseChanges dataCreate a new pause for a subscription. API summary: Pause a maintenance plan.
  • create_subscription_resumeChanges dataCreate a new resume for a subscription. API summary: Resume a paused maintenance plan.
  • create_subscription_subscribeChanges dataCreate a new subscribe for a subscription. API summary: Get Stripe Checkout URL for a pending auto-charge plan.
  • create_surface_typeChanges dataCreate a new surface type. Required: name. API summary: Create a surface type.
  • create_templateChanges dataCreate a new template. Required: template. Search templates first to avoid duplicates. API summary: Create a template.
  • create_ticketChanges dataCreate a new ticket. Required: category, description or subject. Search tickets first to avoid duplicates. API summary: Create a support ticket.
  • create_ticket_mediumChanges dataCreate a new medium for a ticket. Required: byte size, content type, filename or object key. API summary: Finalize media upload.
  • create_ticket_messageVisible to othersCreate a new message for a ticket. Required: message. Has effects visible outside this system. API summary: Add message to ticket.
  • create_waiverChanges dataCreate a new waiver. API summary: Accept liability waiver for quote.
  • create_webhookDeletesCreate a new webhook. Required: events or url. Destructive action; may require approval. API summary: Create a webhook endpoint.
  • create_webhook_rotateDeletesCreate a new rotate for a webhook. Destructive action; may require approval. API summary: Rotate webhook secret.
  • create_webhook_testDeletesCreate a new test for a webhook. Destructive action; may require approval. API summary: Send test webhook.
  • delete_a_lead_sourceDeletesPermanently delete a lead by lead id. Destructive action; may require approval. API summary: Delete a lead source.
  • delete_a_quoteDeletesPermanently delete a quote by quote id. Destructive action; may require approval.
  • delete_avatarsMoves moneyPermanently delete a avatar. Financial or irreversible action; may require approval. API summary: Remove avatar.
  • delete_campaignDeletesPermanently delete a campaign by campaign id. Destructive action; may require approval. API summary: Delete a marketing campaign (draft or scheduled only).
  • delete_customerDeletesPermanently delete a customer by customer id. Destructive action; may require approval.
  • delete_customer_addressDeletesPermanently delete a address by address id. Destructive action; may require approval. API summary: Remove a saved customer address.
  • delete_customer_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a customer's note.
  • delete_customer_portal_accessesMoves moneyPermanently delete a portal access by customer id. Financial or irreversible action; may require approval. API summary: Revoke customer portal access.
  • delete_employeeDeletesPermanently delete a employee by employee id. Destructive action; may require approval. API summary: Delete an invitation.
  • delete_expenseDeletesPermanently delete a expense by expense id. Destructive action; may require approval. API summary: Delete expense.
  • delete_expense_mediumDeletesPermanently delete a medium by media id. Destructive action; may require approval. API summary: Delete media.
  • delete_follow_upDeletesPermanently delete a follow up by follow up id. Destructive action; may require approval. API summary: Delete a follow-up.
  • delete_invoiceDeletesPermanently delete a invoice by invoice id. Destructive action; may require approval. API summary: Delete an invoice.
  • delete_invoicesMoves moneyPermanently delete a invoice by invoice id. Financial or irreversible action; may require approval. API summary: Clear the promo code applied to an invoice.
  • delete_leadDeletesPermanently delete a lead by lead id 2. Destructive action; may require approval. API summary: Delete a lead event.
  • delete_lead_api_lead_deleteDeletesPermanently delete a lead by lead id. Destructive action; may require approval.
  • delete_lead_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a lead's note.
  • delete_logosMoves moneyPermanently delete a logo. Financial or irreversible action; may require approval. API summary: Remove logo.
  • delete_notificationDeletesPermanently delete a notification by notification id. Destructive action; may require approval.
  • delete_notificationsMoves moneyPermanently delete a notification. Financial or irreversible action; may require approval. API summary: Delete multiple notifications.
  • delete_packageDeletesPermanently delete a package by package id. Destructive action; may require approval. API summary: Delete a maintenance package.
  • delete_pricing_templateDeletesPermanently delete a pricing template by pricing template id. Destructive action; may require approval.
  • delete_projectDeletesPermanently delete a project by project id. Destructive action; may require approval. API summary: Delete a job.
  • delete_project_feedbackDeletesPermanently delete a feedback by feedback id. Destructive action; may require approval. API summary: Delete customer feedback for a job.
  • delete_project_messageDeletesPermanently delete a message by message id. Destructive action; may require approval. API summary: Delete a job note.
  • delete_project_photoDeletesPermanently delete a photo by photo id. Destructive action; may require approval.
  • delete_project_seriesMoves moneyPermanently delete a series by job id. Financial or irreversible action; may require approval. API summary: Delete an entire job series.
  • delete_promo_codeDeletesPermanently delete a promo code by promo code id. Destructive action; may require approval. API summary: Delete a draft Marketing promo code.
  • delete_public_formDeletesPermanently delete a public form by public form id. Destructive action; may require approval.
  • delete_quoteDeletesPermanently delete a quote by quote id. Destructive action; may require approval. API summary: Permanently delete an estimate.
  • delete_quotesMoves moneyPermanently delete a quote by quote id. Financial or irreversible action; may require approval. API summary: Clear the promo code applied to a quote.
  • delete_reminderDeletesPermanently delete a reminder by reminder id. Destructive action; may require approval.
  • delete_segmentDeletesPermanently delete a segment by segment id. Destructive action; may require approval. API summary: Delete a segment (hard delete).
  • delete_service_requestDeletesPermanently delete a service request by service request id. Destructive action; may require approval.
  • delete_service_request_photoDeletesPermanently delete a photo by photo id. Destructive action; may require approval.
  • delete_smsMoves moneyPermanently delete a sms. Financial or irreversible action; may require approval. API summary: Disable SMS MFA.
  • delete_sms_consentsMoves moneyPermanently delete a sms consent. Financial or irreversible action; may require approval. API summary: Revoke SMS consent.
  • delete_sms_consents_notification_preferences_revoke_sms_consentMoves moneyPermanently delete a sms consent. Financial or irreversible action; may require approval. API summary: Revoke SMS consent for notifications.
  • delete_submissionDeletesPermanently delete a submission by submission id. Destructive action; may require approval.
  • delete_subscriptionDeletesPermanently delete a subscription by subscription id. Destructive action; may require approval. API summary: Delete a maintenance plan.
  • delete_subscriptionsMoves moneyPermanently delete a subscription. Financial or irreversible action; may require approval. API summary: Cancel subscription.
  • delete_surface_typeDeletesPermanently delete a surface type by surface type id. Destructive action; may require approval.
  • delete_templateDeletesPermanently delete a template by template id. Destructive action; may require approval.
  • delete_ticket_mediumDeletesPermanently delete a medium by media id. Destructive action; may require approval. API summary: Delete a media asset.
  • delete_ticket_messageDeletesPermanently delete a message by message id. Destructive action; may require approval.
  • delete_totpsMoves moneyPermanently delete a totp. Financial or irreversible action; may require approval. API summary: Disable TOTP (Authenticator App).
  • delete_usersMoves moneyPermanently delete a user. Financial or irreversible action; may require approval. API summary: Delete account.
  • delete_webhookDeletesPermanently delete a webhook by webhook id. Destructive action; may require approval. API summary: Delete a webhook endpoint.
  • download_agreementDownload the document for a agreement. API summary: Get a download URL for the executed agreement PDF.
  • download_brand_setting_pdfDownload the pdf document for a brand setting. API summary: Preview a waiver/disclaimer PDF.
  • download_invoice_pdfDownload the pdf document for a invoice. API summary: Download PDF version of invoice.
  • download_quote_pdfDownload the pdf document for a quote. API summary: Download PDF version of quote.
  • download_the_estimate_pdfDownload the pdf document for a quote. API summary: Download the estimate PDF.
  • export_expensesExport expenses. API summary: Export expenses to CSV, Excel, or PDF.
  • export_expenses_receipts_zipChanges dataExport expenses. API summary: Queue async export of expense receipts as ZIP.
  • export_projectsExport projects. API summary: Export jobs to CSV.
  • export_reportsExport reports. API summary: Export reports data.
  • export_submissionsExport submissions. API summary: Export submissions as CSV.
  • get_a_follow_up_rule_by_idGet one by id by by id id. API summary: Get a follow-up rule by ID.
  • get_a_single_customer_maintenance_planGet one customer for a customer by customer id 2. API summary: Get a single customer maintenance plan.
  • get_an_employeeGet one employee by employee id. API summary: Get an employee.
  • get_by_idGet one by id by by id id. API summary: Get a reminder rule by ID.
  • get_campaignGet one campaign by campaign id. API summary: Get a single marketing campaign.
  • get_companycam_configGet one companycam. API summary: Get CompanyCam sync configuration.
  • get_companycam_statusGet the current status of a companycam. API summary: CompanyCam connection status.
  • get_customerGet one customer by `customer_id`, with contact details and addresses.
  • get_customer_messageGet one message for a customer by message id. API summary: Get one customer note.
  • get_customer_s_primary_addressList addresses. API summary: Get customer's primary address.
  • get_employeeGet one employee by employee id. API summary: Get an invitation.
  • get_employee_performance_metricsList employees for a employee. Optional filters: year or month. API summary: Get employee performance metrics.
  • get_employer_s_surface_typesList surface types. API summary: Get employer's surface types.
  • get_expenseGet one expense by expense id. API summary: Get expense by ID.
  • get_expense_mediumGet one medium for a expense by medium id. API summary: Get media by ID.
  • get_expense_statisticsList stats. Optional filters: from or to. API summary: Get expense statistics.
  • get_follow_upGet one follow up by follow up id. API summary: Get a follow-up.
  • get_follow_up_ruleGet one follow up rule by trigger. API summary: Get a follow-up automation rule.
  • get_google_calendar_oauth_urlList connect urls. API summary: Get Google Calendar OAuth URL.
  • get_help_docGet one help doc by help doc slug. API summary: Get a help doc by slug.
  • get_invoiceGet one invoice by `invoice_id`, with line items, totals, due date and payment status.
  • get_invoice_2Get one invoice by invoice id. API summary: Get invoice HTML preview.
  • get_jobGet one job by `project_id`, with schedule, address, assigned technicians and line items.
  • get_leadGet one lead by `lead_id`.
  • get_messageGet one message by message id. API summary: Get a single release note.
  • get_notificationGet one notification by notification id. API summary: Get a notification.
  • get_notification_allChanges dataGet one notification. API summary: Mark all notifications as read.
  • get_notification_templateGet one notification template by audience. API summary: Get a notification template.
  • get_packageGet one package by package id. API summary: Get a maintenance package.
  • get_presigned_url_for_avatar_uploadList customers. Optional filters: filename or content type. API summary: Get presigned URL for avatar upload.
  • get_presigned_url_for_logo_uploadList customers. Optional filters: filename or content type. API summary: Get presigned URL for logo upload.
  • get_presigned_url_for_media_uploadChanges dataCreate a new customer. Required: content type or filename. Search customers first to avoid duplicates. API summary: Get presigned URL for media upload.
  • get_presigned_url_for_photo_uploadChanges dataCreate a new customer. Search customers first to avoid duplicates. API summary: Get presigned URL for photo upload.
  • get_previewGet one preview by kind. API summary: Get document preview.
  • get_pricing_templateGet one pricing template by pricing template id. API summary: Get a pricing template.
  • get_promo_codeGet one promo code by promo code id. API summary: Get a Marketing promo code.
  • get_public_formGet one public form by public form id. API summary: Get a public form.
  • get_qbo_oauth_connect_urlList connect urls. API summary: Get QBO OAuth connect URL.
  • get_qbo_stateGet one qbo. API summary: Get QBO sync state.
  • get_quoteGet one quote by `quote_id`, with line items, totals and status.
  • get_quote_2Get one quote by quote id. API summary: Get an estimate.
  • get_quote_html_previewGet one quote by quote id. API summary: Get quote HTML preview.
  • get_quote_previewGet one quote by estimate id. API summary: HTML preview of the estimate document.
  • get_quote_public_estimate_showGet one quote by quote id. API summary: Render an estimate for its recipient (public).
  • get_reminderGet one reminder by reminder id. API summary: Get a reminder.
  • get_reminder_ruleGet one reminder rule by trigger. API summary: Get a reminder automation rule.
  • get_segmentGet one segment by segment id. API summary: Get a single segment.
  • get_service_requestGet one service request by service request id. API summary: Get a service request.
  • get_stripe_statusGet the current status of a stripe. API summary: Get Stripe account status.
  • get_stripe_subscription_status_for_a_planList subscriptions for a subscription. API summary: Get Stripe subscription status for a plan.
  • get_submissionGet one submission by submission id. API summary: Get a submission.
  • get_subscriptionGet one subscription by subscription id. API summary: Get a maintenance plan.
  • get_surface_typeGet one surface type by surface type id. API summary: Get a surface type.
  • get_templateGet one template by template id. API summary: Get a single template.
  • get_template_tagsGet one template. API summary: List supported merge tags.
  • get_ticketGet one ticket by ticket id. API summary: Get a support ticket.
  • get_webhookGet one webhook by webhook id. API summary: Get a webhook endpoint.
  • get_zapier_statusGet the current status of a zapier. API summary: Get Zapier connection status.
  • list_a_customer_s_active_maintenance_plansList customers for a customer. API summary: List a customer's active maintenance plans.
  • list_accountsList accounts. API summary: List connected employer accounts.
  • list_addressesList addresses. API summary: List customer's saved addresses.
  • list_automations_for_a_jobList projects for a project. API summary: List automations for a job.
  • list_brand_settingsList brand settings. API summary: Get brand settings.
  • list_campaign_chartsList charts for a campaign. Optional filters: period, from or to. API summary: Get per-day revenue / profit / event-count chart for a campaign.
  • list_campaign_revenue_attributionsList revenue attributions for a campaign. API summary: Per-campaign revenue attribution with per-recipient breakdown.
  • list_campaign_statsList stats for a campaign. API summary: Get lifetime counters + rates + revenue for a campaign.
  • list_categoriesList categories. API summary: List template categories.
  • list_combined_linksList combined links. API summary: Get the account's combined intake link.
  • list_connect_urlsList connect urls. API summary: Get Google OAuth URL for mobile login.
  • list_customer_messagesList messages for a customer. API summary: List a customer's notes.
  • list_customersList customers for a customer. API summary: Get customer record counts.
  • list_customers_api_marketing_template_presign_imageList customers. Optional filters: filename or content type. API summary: Presign a template logo/hero image upload.
  • list_customers_brand_docs_presignList customers. Optional filters: filename or content type. API summary: Presign a waiver/disclaimer PDF upload.
  • list_dashboard_urlsList dashboard urls. API summary: Get Stripe dashboard login URL.
  • list_dashboardsList dashboards. Optional filters: time range, start date, end date or surface types. API summary: Get dashboard data.
  • list_distinct_lead_tagsList leads. API summary: List distinct lead tags.
  • list_employee_invitationsList employees. Results are paginated. API summary: List employee invitations.
  • list_employeesList the company's employees and technicians, with their IDs for assigning jobs.
  • list_employees_2List employees. API summary: List available employee roles.
  • list_expense_mediaList media for a expense. API summary: List expense media.
  • list_field_poolsList field pools. API summary: List the configurable field pool per form kind.
  • list_fix_syncsList fix syncs. API summary: Get mismatched items between QBO and CleanOps.
  • list_follow_up_rulesList follow up rules. API summary: List follow-up automation rules.
  • list_follow_upsList follow ups. Optional filters: type, job id, quote id, invoice id, customer id or status. Results are paginated. API summary: List follow-ups.
  • list_help_docsList help docs. API summary: List published help docs.
  • list_historiesList histories. Optional filters: months. API summary: Per-channel marketing usage current month plus N-1 prior months.
  • list_integrationsList integrations. API summary: List all integrations.
  • list_invoice_receipt_pdfsList receipt pdfs for a invoice. API summary: Download the customer receipt PDF for a paid invoice.
  • list_invoice_tasksList tasks for a invoice. API summary: List invoice activities.
  • list_invoices_for_a_maintenance_planList invoices for a subscription. Optional filters: sort by or sort dir. Results are paginated. API summary: List invoices for a maintenance plan.
  • list_jobs_for_a_customer_maintenance_planList projects for a subscription. Results are paginated. API summary: List jobs for a customer maintenance plan.
  • list_lead_messagesList messages for a lead. API summary: List a lead's notes.
  • list_lead_sourcesList leads. API summary: List lead sources.
  • list_lead_tasksList tasks for a lead. API summary: List a lead's activity log.
  • list_leadsList leads for a lead. API summary: List a lead's events.
  • list_leads_api_lead_event_account_indexList leads. Optional filters: from or to. API summary: List every lead event in a date range (schedule feed).
  • list_maintenance_plansList subscriptions. Optional filters: status, customer id or billing method. Results are paginated. API summary: List maintenance plans.
  • list_mediaList media. Results are paginated. API summary: List media assets.
  • list_messagesList messages. Results are paginated. API summary: List published release notes.
  • list_mfasList mfas. API summary: Get MFA status.
  • list_notification_preferencesList notification preferences. API summary: Get notification preferences.
  • list_notification_templatesList notification templates. Optional filters: audience.
  • list_notificationsList notifications. Results are paginated.
  • list_package_active_plan_countsList active plan counts for a package. API summary: Count active plans using a maintenance package.
  • list_pendingsList pendings. API summary: List pending announcements for the current user.
  • list_preferencesList preferences. API summary: Get user preferences.
  • list_pricing_templatesList pricing templates.
  • list_project_feedbackList feedback for a project. API summary: List customer feedback for a job.
  • list_project_messagesList messages for a project. API summary: List notes for a job.
  • list_project_open_time_logsList open time logs for a project. API summary: List open time logs for a job.
  • list_project_photosList photos for a project. API summary: List photos for a job.
  • list_project_time_logsList time logs for a project. API summary: List time logs for a job.
  • list_projectsList projects. Optional filters: customer id, start times or exclude job id. API summary: Jobs already scheduled at an instant.
  • list_promo_code_chartsList charts for a promo code. Optional filters: period, from or to. API summary: Get redemption chart series.
  • list_promo_code_redemptionsList redemptions for a promo code. API summary: List recent redemptions for a promo code.
  • list_promo_code_statsList stats for a promo code. API summary: Get aggregate stats for a promo code.
  • list_pullsList pulls. API summary: Get unlinked QBO items for import.
  • list_pushesList pushes. API summary: Get unlinked CleanOps items for push to QBO.
  • list_quote_activitiesList tasks for a quote. API summary: List quote activities.
  • list_quote_agreementsList agreements for a quote. API summary: Get the executed agreement for a quote.
  • list_quote_tasksList tasks for a quote. API summary: Estimate activity log.
  • list_quotesList quotes for a quote. API summary: Get quote terms content.
  • list_receiptsList receipts. Results are paginated.
  • list_reconnect_checksList reconnect checks. API summary: Check if QBO has disconnected links.
  • list_reminder_rulesList reminder rules. API summary: List reminder automation rules.
  • list_remindersList reminders. Optional filters: job id or status. Results are paginated.
  • list_reportsList reports. Optional filters: time range, surface types or show yoy. API summary: Get reports data.
  • list_segment_campaignsList campaigns for a segment. Results are paginated. API summary: Campaigns referencing a segment.
  • list_segment_map_pointsList map points for a segment. API summary: Geocoded member markers for a segment.
  • list_segment_statsList stats for a segment. API summary: Aggregate stats for a segment.
  • list_segment_usersList users for a segment. API summary: Member snapshot for a segment.
  • list_service_request_photosList photos for a service request.
  • list_statsList stats. API summary: Get QBO sync statistics.
  • list_subscription_invoicesList invoices for a subscription. Results are paginated. API summary: List invoices for a customer maintenance plan.
  • list_subscription_projectsList projects for a subscription. Optional filters: sort by or sort dir. Results are paginated. API summary: List jobs for a maintenance plan.
  • list_subscriptionsList subscriptions. API summary: Get subscription and billing history.
  • list_summariesList summaries. API summary: Account-level promo code KPIs.
  • list_surface_type_usagesList usages for a surface type. API summary: Get surface type usage counts.
  • list_surface_typesList surface types.
  • list_ticket_mediaList media for a ticket. API summary: List media for a support ticket.
  • list_unread_countsList unread counts. API summary: Get unread notification count.
  • list_usagesList usages. API summary: Current month per-channel send usage and caps.
  • list_usersList users. API summary: Get current user profile.
  • list_webhook_shipmentsList shipments for a webhook. Results are paginated. API summary: List webhook deliveries.
  • list_webhooksList webhooks. Results are paginated. API summary: List webhook endpoints.
  • publish_a_marketing_campaignVisible to othersPublish a campaign (campaign id). Has effects visible outside this system. API summary: Publish a marketing campaign.
  • publish_a_templateVisible to othersPublish a template (template id). Has effects visible outside this system.
  • refund_addressMoves moneyReverse a address. Financial or irreversible action; may require approval. API summary: Reverse geocode coordinates.
  • reject_quoteVisible to othersDecline a quote (estimate id). Has effects visible outside this system. API summary: Decline an estimate (public).
  • reject_service_requestVisible to othersDecline a service request (service request id). Has effects visible outside this system.
  • reject_submissionVisible to othersReject a submission (submission id). Has effects visible outside this system.
  • remove_a_waiver_disclaimer_pdfDeletesDownload the pdf document for a brand setting. Destructive action; may require approval. API summary: Remove a waiver/disclaimer PDF.
  • remove_an_employeeDeletesPermanently delete a employee by employee id. Destructive action; may require approval. API summary: Remove an employee.
  • replace_a_estimate_public_linkChanges dataCreate a new rotate link for a quote. API summary: Replace a estimate public link.
  • restore_appleChanges dataRestore a apple. API summary: Restore Apple IAP purchases.
  • restore_campaignChanges dataUnarchive a campaign (campaign id). API summary: Restore an archived marketing campaign.
  • restore_customerChanges dataUnarchive a customer (customer id).
  • restore_expenseChanges dataUnarchive a expense (expense id). API summary: Unarchive expense.
  • restore_googleChanges dataRestore a google. API summary: Restore Google Play purchases.
  • restore_invoiceChanges dataUnarchive a invoice (invoice id). API summary: Unarchive an invoice.
  • restore_packageChanges dataUnarchive a package (maintenance package id). API summary: Unarchive a maintenance package.
  • restore_projectChanges dataUnarchive a project (job id). API summary: Unarchive a job.
  • restore_public_formChanges dataUnarchive a public form (public form id).
  • restore_public_form_enableChanges dataEnable a public form (public form id).
  • restore_quoteChanges dataUnarchive a quote (estimate id). API summary: Unarchive an estimate.
  • restore_quote_unarchiveChanges dataUnarchive a quote (quote id).
  • restore_segmentChanges dataUnarchive a segment (segment id). API summary: Unarchive a segment (restore soft delete).
  • restore_service_requestChanges dataUnarchive a service request (service request id).
  • restore_templateChanges dataUnarchive a template (template id).
  • search_autocompletesSearch autocompletes by q. Use this to find existing autocompletes before creating a new autocomplete. Results are paginated. API summary: Autocomplete address.
  • search_campaign_recipientsSearch recipients for a campaign by status, channel, search, date from, date to or sort by. Use this to find existing recipients before creating a new recipient. Results are paginated. API summary: List recipients for a one-time campaign.
  • search_campaign_runsSearch runs for a campaign by status, channel, search, date from or date to. Use this to find existing runs before creating a new run. Results are paginated. API summary: List automation runs for an automation campaign.
  • search_campaignsSearch campaigns by type, status, search, trigger type, audience filter or date from. Use this to find existing campaigns before creating a new campaign. Results are paginated. API summary: List marketing campaigns.
  • search_customersSearch customers by `q` (name, email or phone), with sort and paging. Use to find a customer's ID.
  • search_everythingSearch across customers, leads, jobs, quotes and invoices at once with `q` (name, email, phone or number).
  • search_expensesSearch expenses by source type, source id, category id, technician id, from or to. Use this to find existing expenses before creating a new expense. Results are paginated. API summary: List expenses.
  • search_invoicesSearch invoices by `q`, statuses, customer_ids or date range. Use to find unpaid or overdue invoices.
  • search_jobsSearch jobs by `q`, statuses (draft, scheduled, in_progress, completed, cancelled), customer_ids, technician_ids or date range.
  • search_lead_quotesSearch quotes for a lead by q, statuses, from, to or include archived. Use this to find existing quotes before creating a new quote. Results are paginated. API summary: List a lead's estimates.
  • search_leadsSearch leads by `q`, statuses, sources, tags, assignee or date range. Use to find a lead's ID.
  • search_packagesSearch packages by q, status, archived, sort by or sort dir. Use this to find existing packages before creating a new package. Results are paginated. API summary: List maintenance packages.
  • search_promo_codesSearch promo codes by status, type, expires, sort, value min or value max. Use this to find existing promo codes before creating a new promo code. Results are paginated. API summary: List Marketing promo codes.
  • search_public_formsSearch public forms by q, kinds, kind or archived. Use this to find existing public forms before creating a new public form. Results are paginated. API summary: List public forms.
  • search_quotesSearch quotes by `q`, statuses, customer_ids or date range.
  • search_reviewsSearch reviews by q. Use this to find existing reviews before creating a new review. API summary: List the customer review queue.
  • search_segmentsSearch segments by audience type, include archived, states, from, to or search. Use this to find existing segments before creating a new segment. Results are paginated. API summary: List Marketing segments.
  • search_service_requestsSearch service requests by q, status, statuses, customer id, date from or date to. Use this to find existing service requests before creating a new service request. Results are paginated. API summary: List service requests.
  • search_submissionsSearch submissions by q, forms, kinds, results, channels or source channel. Use this to find existing submissions before creating a new submission. Results are paginated. API summary: List public-form submissions.
  • search_templatesSearch templates by category, status, include archived or search. Use this to find existing templates before creating a new template. Results are paginated. API summary: List Marketing templates.
  • search_ticketsSearch tickets by status, category or search. Use this to find existing tickets before creating a new ticket. Results are paginated. API summary: List support tickets.
  • send_an_estimate_to_its_leadVisible to othersSend a quote (estimate id). Has effects visible outside this system. API summary: Send an estimate to its lead.
  • send_customerVisible to othersSend a customer (customer id). Has effects visible outside this system. API summary: Create and send customer portal invitation.
  • send_follow_upVisible to othersSend a follow up (follow up id). Has effects visible outside this system. API summary: Send follow-up immediately.
  • send_invoiceVisible to othersSend an invoice to its customer by `invoice_id`. The customer is notified immediately.
  • send_messageVisible to othersSend a message. Has effects visible outside this system. API summary: Send email MFA setup code.
  • send_mfaMoves moneyEmail a mfa. Financial or irreversible action; may require approval. API summary: Disable email MFA.
  • send_mfa_codeVisible to othersSend a mfa. Has effects visible outside this system. API summary: Send MFA verification code.
  • send_phone_verification_codeVisible to othersSend a user. Has effects visible outside this system. API summary: Send phone verification code.
  • send_quoteVisible to othersSend a quote to its customer by `quote_id`. The customer is notified immediately.
  • send_reminderVisible to othersSend a reminder (reminder id). Has effects visible outside this system. API summary: Send reminder immediately.
  • send_smsVisible to othersSend a sms. Has effects visible outside this system. API summary: Send SMS MFA setup code.
  • send_userDeletesEmail a user. Destructive action; may require approval. API summary: Update user email.
  • send_user_codeVisible to othersSend a user. Has effects visible outside this system. API summary: Send phone verification code for SMS notifications.
  • submit_appleVisible to othersValidate a apple. Has effects visible outside this system. API summary: Validate Apple IAP purchase.
  • submit_auth_emailVisible to othersVerify a auth. Has effects visible outside this system. API summary: Verify email with 6-digit code.
  • submit_auth_verificationVisible to othersResend a auth. Has effects visible outside this system. API summary: Resend email verification code.
  • submit_campaignVisible to othersDuplicate a campaign (campaign id). Has effects visible outside this system. API summary: Duplicate a marketing campaign.
  • submit_campaign_audienceVisible to othersPreview a campaign (campaign id). Has effects visible outside this system. API summary: Preview a campaign's audience + cap-readiness.
  • submit_campaign_emailVisible to othersPreview a campaign (campaign id). Has effects visible outside this system. API summary: Render a campaign's email preview.
  • submit_companycamVisible to othersSync a companycam (job id). Has effects visible outside this system. API summary: Push a job's photos to CompanyCam.
  • submit_companycam_configDeletesSync a companycam. Destructive action; may require approval. API summary: Update CompanyCam sync configuration.
  • submit_companycam_nowVisible to othersSync a companycam. Has effects visible outside this system. API summary: Sync CompanyCam now.
  • submit_customerVisible to othersValidate a customer. Has effects visible outside this system. API summary: Validate invite code.
  • submit_employeeVisible to othersResend a employee (invitation id). Has effects visible outside this system. API summary: Resend invitation email.
  • submit_googleVisible to othersValidate a google. Has effects visible outside this system. API summary: Validate Google Play purchase.
  • submit_google_calendarDeletesSync a google calendar. Destructive action; may require approval. API summary: Toggle Google Calendar sync.
  • submit_leadVisible to othersComplete a lead (event id). Has effects visible outside this system. API summary: Mark a lead event completed.
  • submit_messageVisible to othersVerify a message. Has effects visible outside this system. API summary: Verify email MFA setup code.
  • submit_mfaVisible to othersVerify a mfa. Has effects visible outside this system. API summary: Verify MFA code.
  • submit_projectVisible to othersPreview a project. Has effects visible outside this system. API summary: Preview recurrence occurrences.
  • submit_promo_codeVisible to othersPublish a promo code (promo code id). Has effects visible outside this system. API summary: State transition: publish.
  • submit_promo_code_duplicateVisible to othersDuplicate a promo code (promo code id). Has effects visible outside this system. API summary: State transition: duplicate.
  • submit_qboVisible to othersSync a qbo. Has effects visible outside this system. API summary: Trigger manual QBO sync.
  • submit_qbo_invoice_statusesVisible to othersSync a qbo. Has effects visible outside this system. API summary: Sync invoice statuses from QBO.
  • submit_segmentVisible to othersRefresh a segment (segment id). Has effects visible outside this system. API summary: Enqueue segment membership refresh.
  • submit_segment_duplicateVisible to othersDuplicate a segment (segment id). Has effects visible outside this system.
  • submit_smsVisible to othersVerify a sms. Has effects visible outside this system. API summary: Verify SMS MFA setup code.
  • submit_stripe_onboardingVisible to othersComplete a stripe. Has effects visible outside this system. API summary: Get Stripe onboarding continuation URL.
  • submit_subscriptionVisible to othersRefresh a subscription. Has effects visible outside this system. API summary: Refresh subscription status from provider.
  • submit_subscription_previewVisible to othersPreview a subscription (maintenance plan id). Has effects visible outside this system. API summary: Preview plan changes.
  • submit_subscription_subscription_linkVisible to othersResend a subscription (maintenance plan id). Has effects visible outside this system. API summary: Resend the subscription link to the customer.
  • submit_templateVisible to othersPreview a template (template id). Has effects visible outside this system. API summary: Render a template preview.
  • submit_template_unpublishVisible to othersUnpublish a template (template id). Has effects visible outside this system.
  • submit_userVisible to othersVerify a user. Has effects visible outside this system. API summary: Verify phone and enable SMS notifications.
  • submit_user_verifyVisible to othersVerify a user. Has effects visible outside this system. API summary: Verify phone number.
  • update_a_lead_sourceChanges dataUpdate an existing lead identified by lead id. Only the fields you pass are changed. API summary: Update a lead source.
  • update_addressesVisible to othersUpdate an existing address. Has effects visible outside this system. API summary: Update customer's primary address.
  • update_auto_syncsVisible to othersUpdate an existing auto sync. Has effects visible outside this system. API summary: Toggle QBO auto-sync.
  • update_brand_settingsVisible to othersUpdate an existing brand setting. Has effects visible outside this system. API summary: Update brand settings.
  • update_by_idChanges dataUpdate an existing by id identified by by id id. API summary: Update a reminder rule by ID.
  • update_campaignChanges dataUpdate an existing campaign identified by campaign id. Only the fields you pass are changed. API summary: Update a marketing campaign.
  • update_campaign_stepsVisible to othersUpdate an existing step identified by campaign id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Upsert the automation's single step (delay + per-step content).
  • update_colorsVisible to othersUpdate an existing color. Has effects visible outside this system. API summary: Update brand colors.
  • update_companiesVisible to othersUpdate an existing company. Has effects visible outside this system. API summary: Update company details.
  • update_customerChanges dataUpdate a customer by `customer_id`: name, email, phone, company name or type.
  • update_customer_addressChanges dataUpdate an existing address identified by address id. API summary: Update a saved customer address.
  • update_customer_messageChanges dataUpdate an existing message identified by message id. API summary: Edit a customer's note.
  • update_disclaimersVisible to othersUpdate an existing disclaimer. Has effects visible outside this system. API summary: Update disclaimer content.
  • update_employeeChanges dataUpdate an existing employee identified by employee id. Only the fields you pass are changed. API summary: Update an employee.
  • update_expenseChanges dataUpdate an existing expense identified by expense id. Only the fields you pass are changed. API summary: Update expense.
  • update_follow_upChanges dataUpdate an existing follow up identified by follow up id. API summary: Update a follow-up.
  • update_follow_up_ruleChanges dataUpdate an existing follow up rule identified by trigger. API summary: Create or update a follow-up automation rule.
  • update_follow_up_rule_reset_channelChanges dataUpdate an existing reset channel identified by channel. API summary: Reset a single follow-up channel to default.
  • update_invoiceChanges dataUpdate an invoice by `invoice_id`: line items, dates, status, tax, discounts, notes or paid details (is_paid, date_paid).
  • update_jobChanges dataUpdate a job by `project_id`: schedule, status, address, description, assignees or completion notes. suppress_notifications avoids customer messages.
  • update_leadChanges dataUpdate a lead by `lead_id`: status, contact details, next action, next step date, tags, notes or assignee.
  • update_lead_2Changes dataUpdate an existing lead identified by lead id 2. Only the fields you pass are changed. API summary: Update a lead event.
  • update_lead_messageChanges dataUpdate an existing message identified by message id. API summary: Edit a lead's note.
  • update_leadsVisible to othersUpdate an existing lead. Has effects visible outside this system. API summary: Reorder surface types.
  • update_notification_preferenceChanges dataUpdate an existing notification preference identified by channel. API summary: Toggle notification channel.
  • update_notification_readsVisible to othersUpdate an existing read identified by notification id. Has effects visible outside this system. API summary: Mark notification as read.
  • update_notification_templateChanges dataUpdate an existing notification template identified by audience. API summary: Update a notification template.
  • update_packageChanges dataUpdate an existing package identified by package id. Only the fields you pass are changed. API summary: Update a maintenance package.
  • update_package_toggle_activesVisible to othersUpdate an existing toggle active identified by maintenance package id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Toggle a maintenance package's active flag.
  • update_passwordsMoves moneyUpdate an existing password. Financial or irreversible action; may require approval. API summary: Change password.
  • update_phone_numberVisible to othersUpdate an existing user. Has effects visible outside this system. API summary: Update phone number.
  • update_photo_customersVisible to othersUpdate an existing customer identified by photo id. Has effects visible outside this system. API summary: Update photo annotations.
  • update_preferencesVisible to othersUpdate an existing preference. Has effects visible outside this system. API summary: Update user preferences.
  • update_pricing_templateChanges dataUpdate an existing pricing template identified by pricing template id. API summary: Update a pricing template.
  • update_project_feedbackChanges dataUpdate an existing feedback identified by feedback id. API summary: Update customer feedback for a job.
  • update_project_messageChanges dataUpdate an existing message identified by message id. API summary: Update a job note.
  • update_promo_codeChanges dataUpdate an existing promo code identified by promo code id. Only the fields you pass are changed. API summary: Update a Marketing promo code.
  • update_public_formChanges dataUpdate an existing public form identified by public form id. Only the fields you pass are changed. API summary: Update a public form.
  • update_quoteChanges dataUpdate a quote by `quote_id`: line items, status, tax, discounts, notes or address.
  • update_quote_2Changes dataUpdate an existing quote identified by quote id. Only the fields you pass are changed. API summary: Update an estimate.
  • update_readsVisible to othersUpdate an existing read. Has effects visible outside this system. API summary: Mark multiple notifications as read.
  • update_reminderChanges dataUpdate an existing reminder identified by reminder id. API summary: Update a reminder.
  • update_reminder_ruleChanges dataUpdate an existing reminder rule identified by trigger. API summary: Create or update a reminder automation rule.
  • update_reset_channelChanges dataUpdate an existing reset channel identified by channel. API summary: Reset a single reminder channel to default.
  • update_segmentChanges dataUpdate an existing segment identified by segment id. Only the fields you pass are changed. API summary: Update a segment.
  • update_service_requestChanges dataUpdate an existing service request identified by service request id. Only the fields you pass are changed. API summary: Update a service request.
  • update_submission_contactsVisible to othersUpdate an existing contact identified by submission id. Has effects visible outside this system. API summary: Edit a pending submission's contact details.
  • update_subscriptionChanges dataUpdate an existing subscription identified by subscription id. Only the fields you pass are changed. API summary: Update a maintenance plan.
  • update_subscriptionsVisible to othersUpdate an existing subscription. Has effects visible outside this system. API summary: Change subscription plan.
  • update_surface_typeChanges dataUpdate an existing surface type identified by surface type id. API summary: Update a surface type.
  • update_templateChanges dataUpdate an existing template identified by template id. Only the fields you pass are changed. API summary: Update a template.
  • update_ticket_messageVisible to othersUpdate an existing message identified by message id. Has effects visible outside this system. API summary: Update a message.
  • update_ticketsVisible to othersUpdate an existing ticket identified by ticket id. Has effects visible outside this system. API summary: Update ticket description.
  • update_togglesVisible to othersUpdate an existing toggle. Has effects visible outside this system. API summary: Enable or disable MFA.
  • update_usersVisible to othersUpdate an existing user. Has effects visible outside this system. API summary: Update user profile.
  • update_waiversVisible to othersUpdate an existing waiver. Has effects visible outside this system. API summary: Update waiver content.
  • update_webhookDeletesUpdate an existing webhook identified by webhook id. Only the fields you pass are changed. Destructive action; may require approval. API summary: Update a webhook endpoint.
  • upload_customer_customersChanges dataImport a customer. API summary: Import selected QBO customers.
  • upload_customer_invoicesChanges dataImport a customer. API summary: Import selected QBO invoices.

Set up in three steps

  1. 1

    Pick the app

    Create a free HeyMyApps account and choose CleanOps from the app list.

  2. 2

    Paste your key

    Paste your CleanOps API key. In CleanOps go to Settings → APIs & Webhooks and create an API key. Copy the key (it starts with cleanops_key_).

  3. 3

    Add the link to your AI

    You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:

    1. Click your name, then Settings › Connectors › Add custom connector.
    2. Paste your link as the Remote MCP server URL.
    3. Switch it on from the + menu in a chat.

Questions

What can the AI do in CleanOps?

It can search and read customers, leads, jobs, quotes, invoices and employees, or search across all of them at once. It can create and update customers, leads, jobs, quotes and invoices, add internal notes, convert leads to customers, mark jobs completed and send quotes and invoices to customers.

Does the AI see my CleanOps API key?

No. Your CleanOps API key is encrypted at rest and never shown to the AI. After you save it, it is not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start read-only. Sending a quote or invoice notifies the customer right away, and completing a job changes its status. These actions can require your approval before they run. Every tool call is logged.

q

a

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own CleanOps account.

Will my customers get messages when the AI makes changes?

Only in some cases. Sending a quote or invoice notifies the customer immediately. Creating or updating a job may notify the customer, unless the AI sets suppress_notifications. Notes you add are internal and are not sent to customers.

Let your AI work in CleanOps today.

Start free. Your key stays encrypted, and you decide what the AI may do.

Connect CleanOps free

HeyMyApps is not affiliated with CleanOps. Product names are trademarks of their owners.