Private preview of the new site. Not live.

customers.create

Add a customer to a shop, with kind, company, email, phone, billing address, lead source, tags and notes in one call.

WhoAgents can call this
RESTPOST /v1/customers
MCP toolcustomers_create
Writesyes, send an Idempotency-Key
AreaCustomers

When to use it

A new customer. Ask the name, and the email if they want quotes and invoices sent by email.

What to tell the owner

I added the customer.

Input

FieldTypeRequired
shop_idstringyes
namestringyes
kindstring (one of person, company)no
company_namestringno
emailstringno
phonestringno
billing_addressobjectno
billing_address.line1stringno
billing_address.line2stringno
billing_address.localitystringno
billing_address.regionstringno
billing_address.postal_codestringno
billing_address.countrystringno
lead_sourcestringno
tagsarrayno
notesstringno

Example

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

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "name": "Ruiz Plumbing"
}

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_input400A field is missing, the wrong type, or unknown. The message names the field. Fix the input; don't retry as is.
forbidden403This worker's role can't do this, or it needs a person's own sign-in rather than an agent token. Tell the person who can.
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.