Private preview of the new site. Not live.

customers.archive

Archive a customer (hidden from lists, history kept) or bring one back.

WhoAgents can call this
RESTPOST /v1/customers/archive
MCP toolcustomers_archive
Writesyes, send an Idempotency-Key
AreaShop

When to use it

Archive a customer (hidden from lists, history kept) or bring one back.

What to tell the owner

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

Input

FieldTypeRequired
customer_idstring (uuid)yes
archivedbooleanno

Example

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

{
  "customer_id": "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.