notes.add

Write a note on any shop record: a job, visit, photo or video, customer, property, equipment, quote, invoice, request, worker, payment, price book item, maintenance plan or the shop (target_kind and target_id; job_id or visit_id alone also work). Any shop member can. Notes are internal to the shop and never shown to the customer. Set audience office to keep it to owner and office (owner or office only); notes on a worker or payment are always office. pinned keeps it at the top (owner or office only). Attach photos or videos already on the job with media_ids. Mention members to notify them; say what you need from them in the note. Write down what the worker tells you about a record here so the next person sees it. Pass channel when the words came from a text, an email, a call, or the visit (typed, email, call, text, visit). It is stored on the note.

WhoAgents can call this
RESTPOST /v1/notes
MCP toolnotes_add
Writesyes, send an Idempotency-Key
AreaField work (checklists, forms, time, notes, change orders, subcontractors)

When to use it

Keep the shop's own notes on a job or one visit (notes.add). For a voice memo, transcribe it with your own speech-to-text and save the words with notes.addVoiceMemo (transcript, duration_seconds, and optionally recorded_at, transcribed_with and language); core runs no speech model and does not store the audio.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
target_kindstring (one of job, visit, media, customer, property, equipment, quote, invoice, request, worker, payment, pricebook_item, maintenance_plan, shop)no
target_idstring (uuid)no
job_idstring (uuid)no
visit_idstring (uuid)no
bodystringyes
channelstring (one of typed, email, call, text, visit)no
audiencestring (one of team, office)no
pinnedbooleanno
media_idsarrayno
mentionsarrayno
agent_namestringno

Example

POST https://doingwork.work/v1/notes
content-type: application/json
Idempotency-Key: 3f1c...

{
  "body": "..."
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.