Private preview of the new site. Not live.

fields.set

Set one custom field value on a customer, property, job, quote or invoice.

WhoAgents can call this
RESTPOST /v1/fields/set
MCP toolfields_set
Writesyes, send an Idempotency-Key
AreaImports, custom fields, tags and search

When to use it

Set one custom field value on a customer, property, job, quote or invoice.

What to tell the owner

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

Input

FieldTypeRequired
shop_idstring (uuid)yes
keystringyes
targetstring (one of customer, property, job, quote, invoice)yes
object_idstring (uuid)yes
valuestringyes
currencystringno

Example

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

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "key": "...",
  "target": "customer",
  "object_id": "00000000-0000-4000-8000-000000000000",
  "value": "..."
}

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.