ClientsService
Available as client.clients. Every operation is scoped by workspaceId.
| Method | Purpose |
|---|---|
getSignupBuckets(workspaceId, query?) | Get time-bucketed signup analytics |
list(workspaceId, options?) | List and search clients |
get(workspaceId, clientId) | Get a client |
create(workspaceId, data) | Create a client |
update(workspaceId, clientId, data) | Update a client |
delete(workspaceId, clientId) | Delete a client |
anonymize(workspaceId, clientId) | Anonymize personal data |
findByEmail(workspaceId, email) | Find an exact email match |
findByExternalId(workspaceId, externalId) | Find an external ID match |
findByPhone(workspaceId, phone) | Find an exact phone match |
getCustomFields(workspaceId, clientId) | Read custom fields |
updateCustomFields(workspaceId, clientId, fields) | Replace custom fields |
setCustomField(workspaceId, clientId, name, value) | Set one custom field |
removeCustomField(workspaceId, clientId, name) | Remove one custom field |
mergeCustomFields(workspaceId, clientId, fields) | Merge custom fields |
listEvents(workspaceId, clientId, query?) | List the client's events |
createEvent(workspaceId, data) | Create a client event |
getPasses(workspaceId, clientId) | List the client's passes |