Private preview of the new site. Not live.

bulk.run

Run one safe action on up to 200 records: customers.addTags, customers.removeTags, customers.archive, customers.unarchive, jobs.addTags, jobs.removeTags, visits.assign. Each item goes through the shop's approval rules like a single call and is reported as done, approval_required or failed.

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

When to use it

Tag, untag, archive or unarchive up to 200 records in one call. Each record gets its own result, so one bad id does not stop the rest.

What to tell the owner

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

Input

FieldTypeRequired
shop_idstring (uuid)yes
actionstring (one of customers.addTags, customers.removeTags, customers.archive, customers.unarchive, jobs.addTags, jobs.removeTags, visits.assign)yes
idsarrayyes
tagsarrayno
person_idsarrayno

Example

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

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "action": "customers.addTags",
  "ids": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

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.