Skip to main content

Clients

The endpoints available in this documentation empower you to perform various client-related operations, facilitating effective client engagement and organization.

Explore the following functionalities to manage clients:

  • Add Client: Create new clients within the platform, supplying the necessary client details via the designated endpoint.
  • Search Clients: Retrieve clients based on specified parameters or keywords, allowing for efficient search capabilities.
  • Get Client by ID: Fetch detailed information about a specific client using their unique identifier.
  • Update Client: Modify and update client information, ensuring accurate and up-to-date records.
  • Add Client Tag: Associate tags with clients, enabling categorization and streamlined organization.
  • Remove Client Tag: Effortlessly remove tags associated with clients, facilitating flexible tag management.
  • Remove Client: Delete clients from the platform, facilitating data management and organization.
API regionapi.whautomate.com

Creates a new client based on parameters​

POST /v1/clients
Headers
x-api-keystringrequired
Your Whautomate API key.
Body
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photoUrlstring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Response 200
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Request
curl -X POST "https://api.whautomate.com/v1/clients" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "fullName": "string",
    "contactType": "HOME",
    "countryCode": "string",
    "phone": "string",
    "email": "string",
    "registrationDate": "string",
    "dob": "string",
    "addressType": "HOME",
    "address": "string",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "string"
    ],
    "notes": "string",
    "referralSource": "string",
    "primaryLocation": {
      "id": "string",
      "title": "string"
    },
    "primaryStaff": {
      "id": "string"
    },
    "customFields": {},
    "photoUrl": "string",
    "emergencyRelationType": "string",
    "emergencyName": "string",
    "emergencyCountryCode": "string",
    "identificationNumber": "string",
    "emergencyPhone": "string"
  }'
Response 200
{
  "id": "string",
  "fullName": "string",
  "contactType": "HOME",
  "countryCode": "string",
  "phone": "string",
  "email": "string",
  "registrationDate": "string",
  "dob": "string",
  "addressType": "HOME",
  "address": "string",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "string"
  ],
  "notes": "string",
  "referralSource": "string",
  "primaryLocation": {
    "id": "string",
    "title": "string"
  },
  "primaryStaff": {
    "id": "string"
  },
  "customFields": {},
  "photo": "string",
  "emergencyRelationType": "string",
  "emergencyName": "string",
  "emergencyCountryCode": "string",
  "identificationNumber": "string",
  "emergencyPhone": "string"
}

Search clients based on parameters

GET /v1/clients​

GET /v1/clients
Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitstring
primaryLocationIdstring
tagsstring
endDatestring
pagestring
startDatestring
searchTextstring
Response 200
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Request
curl -X GET "https://api.whautomate.com/v1/clients" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "string",
    "fullName": "string",
    "contactType": "HOME",
    "countryCode": "string",
    "phone": "string",
    "email": "string",
    "registrationDate": "string",
    "dob": "string",
    "addressType": "HOME",
    "address": "string",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "string"
    ],
    "notes": "string",
    "referralSource": "string",
    "primaryLocation": {
      "id": "string",
      "title": "string"
    },
    "primaryStaff": {
      "id": "string"
    },
    "customFields": {},
    "photo": "string",
    "emergencyRelationType": "string",
    "emergencyName": "string",
    "emergencyCountryCode": "string",
    "identificationNumber": "string",
    "emergencyPhone": "string"
  }
]
warning

Please do note the {clientId} in the URL path denotes the UUID - Id of the client.

E.g. 5tw9zcQkbu

Gets a Client by Id​

GET /v1/clients/{clientId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Response 200
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Request
curl -X GET "https://api.whautomate.com/v1/clients/{clientId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "fullName": "string",
  "contactType": "HOME",
  "countryCode": "string",
  "phone": "string",
  "email": "string",
  "registrationDate": "string",
  "dob": "string",
  "addressType": "HOME",
  "address": "string",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "string"
  ],
  "notes": "string",
  "referralSource": "string",
  "primaryLocation": {
    "id": "string",
    "title": "string"
  },
  "primaryStaff": {
    "id": "string"
  },
  "customFields": {},
  "photo": "string",
  "emergencyRelationType": "string",
  "emergencyName": "string",
  "emergencyCountryCode": "string",
  "identificationNumber": "string",
  "emergencyPhone": "string"
}

Updates a particular client​

PUT /v1/clients/{clientId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Body
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photoUrlstring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Response 200
idstring
fullNamestringrequired
contactTypestring (enum)
One of: HOME, MOBILE, WORK.
countryCodestringrequired
phonestringrequired
emailstring
registrationDatestring
dobstring
addressTypestring (enum)
One of: HOME, WORK.
addressstring
genderstring (enum)
One of: Male, Female, Unknown, Other.
maritalStatusstring (enum)
One of: UNMARRIED, MARRIED, OTHER.
tagsstring[]
notesstring
referralSourcestring
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
Company name, for business clients.
taxIdTypestring
Type of tax ID, for example GST or VAT.
taxIdNumberstring
Tax ID number, shown on invoices.
Request
curl -X PUT "https://api.whautomate.com/v1/clients/{clientId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "fullName": "string",
    "contactType": "HOME",
    "countryCode": "string",
    "phone": "string",
    "email": "string",
    "registrationDate": "string",
    "dob": "string",
    "addressType": "HOME",
    "address": "string",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "string"
    ],
    "notes": "string",
    "referralSource": "string",
    "primaryLocation": {
      "id": "string",
      "title": "string"
    },
    "primaryStaff": {
      "id": "string"
    },
    "customFields": {},
    "photoUrl": "string",
    "emergencyRelationType": "string",
    "emergencyName": "string",
    "emergencyCountryCode": "string",
    "identificationNumber": "string",
    "emergencyPhone": "string"
  }'
Response 200
{
  "id": "string",
  "fullName": "string",
  "contactType": "HOME",
  "countryCode": "string",
  "phone": "string",
  "email": "string",
  "registrationDate": "string",
  "dob": "string",
  "addressType": "HOME",
  "address": "string",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "string"
  ],
  "notes": "string",
  "referralSource": "string",
  "primaryLocation": {
    "id": "string",
    "title": "string"
  },
  "primaryStaff": {
    "id": "string"
  },
  "customFields": {},
  "photo": "string",
  "emergencyRelationType": "string",
  "emergencyName": "string",
  "emergencyCountryCode": "string",
  "identificationNumber": "string",
  "emergencyPhone": "string"
}

Deletes a client based on clientId​

DEL /v1/clients/{clientId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Response 200
successboolean
Request
curl -X DELETE "https://api.whautomate.com/v1/clients/{clientId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "success": true
}

POST /v1/clients/{clientId}/tags/add​

POST /v1/clients/{clientId}/tags/add
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Response 200
idstring
tagsstring[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/{clientId}/tags/add" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "tags": [
    "string"
  ]
}

POST /v1/clients/{clientId}/tags/remove​

POST /v1/clients/{clientId}/tags/remove
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Response 200
idstring
tagsstring[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/{clientId}/tags/remove" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "tags": [
    "string"
  ]
}
Last updated on