Customers
Customers represent the people who interact with your agents. You can store contact information, custom fields, and tags to segment them.
Available endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/clients | List every customer |
GET | /v1/clients/{id} | Get a customer by ID or phone |
POST | /v1/clients | Create a new customer |
PATCH | /v1/clients/{id} | Update a customer by phone |
DELETE | /v1/clients/{id} | Delete a customer by ID or phone |
GET | /v1/clients/{clientId}/conversations | List every conversation of a customer |
PATCH | /v1/clients/{id}/moderation | Block, unblock, or reset strikes |
Customers can have custom fields defined per workspace. See the Custom Fields section to list, create, update, or delete them.
Status and moderation
Every customer has a status (active or blocked) and a moderation object holding their history. A blocked customer stops getting automatic replies: their new conversations start out marked as spam and agents skip them.
Strikes are accumulated by the moderation system when it detects content that breaks the agent's safety rules, and crossing the agent's threshold blocks the customer automatically. To step in manually there is a single endpoint, Moderate a Customer , where you declare how you want them to end up.
Unblocking a customer resets their strikes, because otherwise the next offence would cross the threshold again right away. It does not work the other way around: resetting the strikes of a blocked customer does not unblock them.
/moderation accepts the customer ID or their phone. PATCH /v1/clients/{id}, by contrast, only accepts the phone, so use /moderation for contacts without a number (webchat, Instagram, Telegram).