Clients
List clients
GET /v1/clients
Scope: clients:read
| Parameter | In | Required |
|---|
q | query | No |
tab | query | No |
labelId | query | No |
locationId | query | No |
segmentId | query | No |
ids | query | No |
sort | query | No |
page | query | No |
pageSize | query | No |
Create a client
POST /v1/clients
Scope: clients:create
| Body field | Type | Required |
|---|
locationId | | No |
ownerMembershipId | | No |
visibility | | No |
secondaryOwnerIds | array | No |
priceListId | | No |
salutationId | | No |
firstName | string | Yes |
lastName | string | Yes |
gender | | No |
dateOfBirth | | No |
language | | No |
sourceId | | No |
email | | No |
mobile | | No |
phone | | No |
address | object | No |
labelIds | array | No |
custom | object | No |
optIns | object | No |
privacyConsent | string | No |
confidentialChannel | | No |
confidentialAddress | | No |
secureChatBlocked | boolean | No |
Get a client
GET /v1/clients/{id}
Scope: clients:read
| Parameter | In | Required |
|---|
id | path | Yes |
Update a client
PATCH /v1/clients/{id}
Scope: clients:update
| Parameter | In | Required |
|---|
id | path | Yes |
If-Match | header | No |
| Body field | Type | Required |
|---|
locationId | | No |
ownerMembershipId | | No |
visibility | | No |
secondaryOwnerIds | array | No |
priceListId | | No |
salutationId | | No |
firstName | string | No |
lastName | string | No |
gender | | No |
dateOfBirth | | No |
language | | No |
sourceId | | No |
email | | No |
mobile | | No |
phone | | No |
address | object | No |
labelIds | array | No |
custom | object | No |
optIns | object | No |
privacyConsent | string | No |
confidentialChannel | | No |
confidentialAddress | | No |
secureChatBlocked | boolean | No |
status | string | No |