Create a customer
createCustomerAdd a new customer profile with contact details, address, and coordinates. Sync customers from your CRM or intake flow to book job requests against their account.
Instructions
Create a customer
Creates a customer record — the client/account profile a job request (work order) is booked against; use it to import or sync customers from your own CRM, website lead form or intake flow. Address (street, city, postal_code, ...) and coordinates (latitude/longitude) live under the nested address object. service_area_id must be a valid service area UUID belonging to this business.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | No | Your external reference for this customer (your own system's ID). Optional; max 32 chars. | |
| tier | No | Loyalty tier. Defaults to "regular" if omitted. | |
| No | Email address. Optional, but at least one of phone/email is required. | ||
| phone | No | Phone number. Optional, but at least one of phone/email is required; 10–20 chars. | |
| address | No | Postal address and coordinates. | |
| full_name | Yes | Customer's full name. Required; max 255 chars. | |
| sms_opt_in | No | SMS consent: set true ONLY when the customer explicitly agreed to receive SMS (e.g. ticked a non-pre-checked consent box, or gave verbal/written consent you keep a record of). SMS notifications are suppressed while false. | |
| idempotency_key | No | Unique key making retries safe: a repeat send with the same key replays the original response (header Idempotent-Replayed: true) instead of re-running the operation. Reusing a key with a different body returns 422 IDEMPOTENCY_KEY_REUSE. (sent as the Idempotency-Key header) | |
| service_area_id | No | UUID of the service area for this customer. Must belong to this business. | |
| preferred_technician_id | No | UUID of the technician this customer prefers. Must belong to this business. |