Consent and human steps

Some actions need a person: a signature, a card, consent to renewal terms, or a decision about money. Doing Work enforces this. Hosted-page operations return human_only (403) on the API and aren't MCP tools. Person-only operations refuse agent tokens with forbidden.

ActionWho does itWhat you do
auth.redeemLinkHosted page only (a person does it in the browser)Never call it yourself. The person's browser does this when they open the sign-in link.
media.requestCaptureHosted page only (a person does it in the browser)Never call it yourself. Used by the hosted camera page when a worker takes a photo in the browser.
jobs.confirmHosted page only (a person does it in the browser)Never call it. The customer confirms or flags a problem on the hosted page.
quotes.signHosted page only (a person does it in the browser)Never call it. The customer opens the link from the email or text and types signer_name. They do not need a Doing Work account, and a signed-in browser session is not the signer. n is the hidden value printed on the quote page and bound to this link.
subcontractors.signHosted page only (a person does it in the browser)Never call it. The owner or office signs on the hosted page.
payments.connectStartHosted page only (a person does it in the browser)Never call it. The owner connects their own Stripe account on the hosted page.
invoices.payHosted page only (a person does it in the browser)Never call it. The customer pays on the hosted page.
platforms.grantManageHosted page only (a person does it in the browser)Never call it. The shop owner allows a platform on the hosted page.
customers.privacyDeleteA person's own sign-in only (agent tokens are refused)Erase a customer's personal details for a privacy request. Money and job records stay, unnamed.
quotes.respondHosted page only (a person does it in the browser)Customer declines a quote or asks for changes (hosted page). Asking for changes needs a note and puts the quote back to draft for the shop to revise.
shops.setAgentMoneyA person's own sign-in only (agent tokens are refused)Owner only, not an agent: set what this shop's agents may do with money. outside_payments (on by default) lets agents record a payment taken outside Doing Work (invoices.markPaidOutside).
cards.resaveHosted page only (a person does it in the browser)Open the card saving page from a save-your-card-again email link (hosted page only). Returns the processor URL where the customer saves the card on the shop's current payments account.
maintenance.confirmPriceA person's own sign-in only (agent tokens are refused)Apply an agent's proposed price on a maintenance plan. Owner or office, from their own sign-in, never an agent.
keys.createA person's own sign-in only (agent tokens are refused)Make a named agent key for one shop (owner only). The owner accepts the agent key terms by passing accept_terms_version.
agents.approveHosted page only (a person does it in the browser)Hosted claim page only: the shop owner whose email the claim names types the agent's 6 digit code, picks one of their shops and accepts the agent key terms. Makes a named agent key for that shop.
agents.denyHosted page only (a person does it in the browser)Hosted claim page only: the person turns the agent down. The registration closes and the agent's poll gets access_denied.
members.setPermissionsA person's own sign-in only (agent tokens are refused)Owner only, not an agent: turn a worker's permissions on or off. Give only the flags to change (see_prices, see_costs, take_money, delete, manage_schedule).
shops.setSendPermissionsA person's own sign-in only (agent tokens are refused)Owner only, not an agent: turn sending quotes, invoices or visit recaps on or off for one role (office, lead or field). Give only the switches to change.
legal.acceptA person's own sign-in only (agent tokens are refused)Record that the signed-in person accepts the current version of a legal document (clickwrap). An agent API key cannot record it.
legal.acceptShopTermsHosted page only (a person does it in the browser)The shop owner, on the hosted shop terms page, ticks the box and accepts the current Terms of Service for the shop (accept_terms_version). Records the time, version, person, IP address and browser.
legal.arbitrationOptOutHosted page only (a person does it in the browser)The shop owner, on the hosted shop terms page, opts the shop out of section 19 arbitration and the class action waiver. Works within 30 days after the owner first accepted terms with section 19 for the shop (or, for a shop an agent signed up, after we emailed the owner the terms).
signatures.signHosted page only (a person does it in the browser)Sign a document after reading it, typing your name and agreeing to sign electronically. Hosted page only; agents can never sign.
shops.transferStartHosted page only (a person does it in the browser)Start handing the shop to a current worker (owner, on a hosted page). They accept on their own hosted page within 14 days, and ownership moves at once.
shops.transferAcceptHosted page only (a person does it in the browser)Accept a hand-off and become the shop's owner (the person asked, on a hosted page). The person agrees to the Terms of Service by ticking a box (accept_terms_version); the record keeps the version, time, IP address and browser.
shops.closeHosted page only (a person does it in the browser)Close the shop for good (owner, on a hosted page, typing the shop name). Everyone loses access, agent connections and webhooks stop, every customer link stops working, and the payments account only settles what is in flight.
shops.reopenHosted page only (a person does it in the browser)Reopen a closed shop (only the owner who closed it, on a hosted page, within 90 days of closing). You come back as owner.
subs.viewHosted page only (a person does it in the browser)The subcontractor's page for one job: the shop, job summary, work address, scope note, upcoming visit times and their notes. state is ok, gone (removed, expired, job cancelled or shop closed) or wrong_person (signed in with a different email, or someone else opened it first).
subs.addNoteHosted page only (a person does it in the browser)Leave a note for the shop on this job, as the subcontractor (up to 20 a day). Hosted page only.
network.setAgentOptInA person's own sign-in only (agent tokens are refused)Let the shop's agents turn customer requests on or off and change what the shop takes (owner only, with your own sign-in). On by default.
phone.takeThreadHosted page only (a person does it in the browser)Take a text thread yourself: it is assigned to you, and sends paused by a customer's stop-like message start again once a person has read it.
me.setSmsConsentHosted page only (a person does it in the browser)Grant or revoke Doing Work SMS alerts and check-in consent for the signed-in person. Hosted page only; an agent key cannot opt in for someone.
hub.viewHosted page only (a person does it in the browser)The customer hub for the signed-in customer: their quotes, jobs, invoices with what is still owed, upcoming visits with any change request, requests with this shop, and their active maintenance plans (what each covers, the next visit due, price per term, renewal date and card on file). state is ok, gone (revoked, expired or unknown) or wrong_person (signed in with an email the shop does not have for this customer).
hub.openHosted page only (a person does it in the browser)Open a sent quote or an unpaid invoice from the customer hub: returns a fresh page link for that one item, for the signed-in customer only, good for a day. Refused with conflict for an invoice that cannot take payment now (its Doing Work booking ended, or a no-show on it is disputed).
hub.requestVisitChangeHosted page only (a person does it in the browser)From the customer hub, ask the shop to move (reschedule, with the times that work better) or cancel an upcoming visit. The visit stays as it is until the shop answers.
hub.withdrawVisitChangeHosted page only (a person does it in the browser)From the customer hub, take back your own open request to move or cancel a visit. Hosted page only.
hub.requestWorkHosted page only (a person does it in the browser)From the customer hub, ask the shop for new work. It lands in the shop's requests (source portal) on this customer, with their contact details already filled.
approvals.setRuleA person's own sign-in only (agent tokens are refused)Owner only, not an agent: require owner approval before an agent can run an action. op is an operation id (invoices.send), an area (invoices.*) or * for every write.
approvals.removeRuleA person's own sign-in only (agent tokens are refused)Owner only, not an agent: stop requiring approval for a rule. Pending requests under it stay pending.
approvals.decideA person's own sign-in only (agent tokens are refused)Owner only, not an agent: approve or deny a pending agent action. On approve it runs now, as the owner, and the result is saved on the request.

Rules

  • Never try another route around a refusal. Send the link or ask the person.
  • Never tick a consent box, sign, or enter a card for someone.
  • Say what the person is agreeing to before you send the link, for example the quote total and the e-sign consent.