Customers
Create and manage reusable customer profiles.
A Customer is a reusable profile identified by email or phone.
Marketplaces: acting on behalf of a subaccount
Platforms can manage a connected subaccount's own customers by sending an X-Sync header
alongside their own key (requires the customers capability). See
Subaccounts for the full contract and error cases.
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /customers | Create |
GET | /customers/{id} | Retrieve |
GET | /customers | List |
PUT | /customers/{id} | Update |
DELETE | /customers/{id} | Delete |
The Customer object
idstringfacultatifUnique identifier.
typeenumfacultatifindividual or business.emailstring?facultatifEmail address.
phonestring?facultatifPhone number.
namestring?facultatifFull name.
statusenumfacultatifactive, inactive, blocked.metadataobjectfacultatifFree-form data.
created_atdatetimefacultatifISO 8601 creation timestamp.