Skip to main content
Push customer changes from your system into CurbWaste and keep a stable link using the CurbWaste UUID. This guide is outbound sync; use webhooks when you also need inbound updates from CurbWaste.

​
Prerequisites

  • An API key from the Developer Platform with customers:read and customers:write — see Authentication
  • A place in your system to store the CurbWaste customer UUID after create
The API does not accept partner-supplied customerId on create/update. After create, store data.id (UUID) as your join key. CRM customerId (e.g. C001) is system-assigned and searchable — see Customers.

​
Step 1 — Create and store the UUID

displayName is required. Optional: email, phone, companyName.
Save data.id from the response into your system (shown as $CUSTOMER_ID below).

​
Step 2 — Update when contact fields change

Send at least one of displayName, email, phone, or companyName.

​
Step 3 — Find candidates before linking

Use list + searchTerm when you need to discover an existing CurbWaste record (matches displayName, CRM customerId, email, or phone), then fetch or store that id.

​
Stay current without polling

Register webhooks for customer.created / customer.updated and upsert locally on envelope data.id. See Webhook setup.

Webhook setup

Ingest create/update events instead of polling.

Customers

Identifiers, profile fields, and how customers connect to other domains.

Customers API

Paths, params, and response shapes for /v1/customers.