Whautomate Help
Visit our websitePricingRequest DemoRoadmap
  • 👋Welcome to Whautomate
  • Overview
    • 💡What we do
    • ✨Our Features
  • Fundamentals
    • 🛠️Getting Started
      • Customer Service
      • Marketing
      • Sales
      • E-Commerce
      • Appointments
      • Classes & Subscriptions
    • 🎯Onboarding Checklist
      • Appointments
      • Classes
      • E-Commerce
      • Customer Service
  • Product Guides
    • Communication
      • Connect a Communication Channel
      • Omni Channel Team Inbox
      • Contacts
      • Segmentation & Broadcasts
      • Email/SMS Sender Configuration
      • Marketing opt-out Management
      • ⚡Canned Responses
      • ⭐CSAT Score
    • Automation
      • Triggers
        • Incoming WhatsApp Messages
        • Outgoing WhatsApp Messages
        • Appointment Updates
        • Happy Birthday Automation
        • Client Anniversary Automation
        • When a Client is created
        • When a Client is added to a Tag
        • When a Client is removed from a Tag
        • When a Contact is created
        • When a Contact is added to a Tag
        • When a Contact is removed from a Tag
        • When a Contact Status Changes
        • When a Client Completes a Form
        • When a Client is assigned a Form
        • When someone Completes an anonymous Form
        • Subscription Updates
        • Order Updates
        • Invoice Updates
        • Credits Usage Updates
        • Class Participant Updates
        • Incoming Messenger Messages
        • Outgoing Messenger Messages
        • Incoming Instagram Messages
        • Outgoing Instagram Messages
        • Incoming Telegram Messages
        • Outgoing Telegram Messages
        • Incoming Website Messages
        • Outgoing Website Messages
        • Shopify - Abandoned Cart
        • Shopify - Order Created
        • Shopify - Order Fulfilled
        • Shopify - Order Cancelled
        • WooCommerce - Abandoned Cart
        • WooCommerce - Order Status Changes
      • Setup WhatsApp Chatbot
      • WhatsApp AI Chatbot - Customer Service
      • Telegram AI Chatbot - Customer Service
      • Chatbot Demos
      • WhatsApp Drip Campaign
      • Birthday Wishes Campaign
      • Automate Reviews & Surveys
    • Invoice & Payment links
      • Setup Payment Gateway
      • Update Business Settings
      • Invoice & Payments
      • Invoice Statements
      • Send Invoice PDF - Personalize WhatsApp, Email and SMS template
      • Invoice Request Payment - Personalize WhatsApp, Email and SMS template
    • E-Commerce
      • Setup WhatsApp Catalog
        • Add Items - Manual
        • Add Items - Data Feed
        • Add Items - Connect Partner Platform
      • Manage Inventory & Link WhatsApp Catalog
      • WhatsApp E-Commerce Chatbot
      • Automate Order Updates
      • Automate Order Reviews & Surveys
    • Appointments
      • Setup Team Member Profile
      • Setup Services
      • Book Appointments - Admin
      • Setup Whatsapp Flow Appointment Chatbot
      • Setup Appointment Chatbot
      • Setup Appointment Notifications
      • Setup Appointment Notifications for Staffs
      • Setup Bulk Appointment Notifications
      • Setup Booking Portal
      • Sync Appointments with External Calendars
      • Bulk Import Services
      • Setup Virtual/Online Session Services
      • Setup Virtual/Online Session Notifications
    • Plans & Subscriptions
      • Setup Plans
      • Setup Subscriptions
    • Class Bookings
      • Bulk Import Classes
      • Setup Classes
      • Setup Class Batches
      • Setup Class Notifications
      • Setup Bulk Class Notifications for Participants
      • Setup Class Booking Chatbot
      • Setup Whatsapp Flow Class Booking Chatbot
      • Setup Class Booking Portal
    • Forms
      • Request Form - Personalize WhatsApp, Email and SMS template
      • Personalize Your Form Response PDFs: Template Editor
      • Form Automations
      • Payment Forms
    • Coupons
    • Loyalty Program
      • Automate Loyalty Program Notifications via WhatsApp
    • Integrations
      • WhatsApp Cloud API
        • WhatsApp Payment Method
        • Meta Business Verification
        • WhatsApp Profile
        • WhatsApp Compliance Info
        • WhatsApp Commerce Settings
        • WhatsApp Message Templates
        • Linking WhatsApp Number (WABA) to Your Facebook Page
        • How to Add WhatsApp Button to Your Instagram Account
        • Setup Click-to-WhatsApp Ads (CTWA)
      • Instagram
      • Facebook Messenger
      • Telegram
      • Livechat
      • OpenAI
      • Stripe
      • Razorpay
      • Shopify
        • Shopify Automations
      • WooCommerce
        • Woocommerce Automations
      • Rest API
      • MyFatoorah
      • Zoom
      • Webhooks
        • Clients
        • Contacts
        • Messages
        • Appointments
        • Classes
        • Invoice Updates
      • Zapier
    • Client CRM
      • Bulk Import Clients
      • Client Details
      • Client Notes
      • Client Documents
      • Client Letters
      • Client Forms
    • WhatsApp Chat Widget
    • Whautomate Rest API
      • Client Tags
      • Clients
      • Contact Tags
      • Contacts
      • Locations
      • Staffs
      • Segments
      • Broadcasts
      • Messages
      • Service Categories
      • Services
      • Appointments
      • Classes
      • Webhooks
      • Whautomate REST API Error Messages
    • Whautomate FAQs
      • My WhatsApp Template Message Failing to Send to Some Users?
      • How to Check My WhatsApp Quality Rating and Messaging Limits?
      • How to Install the Whautomate Progressive Web Application?
      • Why Does My Whautomate Account Frequently Log Out?
      • How to Get the WhatsApp Green Tick in 3 Easy Steps
      • Essential Tips to Avoid WhatsApp Business Account/API Restrictions & Bans
      • How to Check Undeliverable or Failed WhatsApp Contacts in Whautomate
      • How to Delete Your WhatsApp Business API Number?
  • Account Management
    • Manage Subscription
      • Choose Your Plan
      • Upgrade Subscription
      • Whautomate Add-ons
      • Update Payment Method
      • Subscription Cancelations
    • Account Settings
    • Team Members Management
      • Invite, Activate or De-activate Members
      • Roles and Permissions
    • Forgot Password
    • Reset Password
    • Two Factor Authentication
  • WhatsApp Pricing
    • WhatsApp pricing Calculator - USD
    • WhatsApp pricing Calculator - INR
    • WhatsApp Pricing Calculator - EUR
Powered by GitBook
On this page
  1. Product Guides
  2. Whautomate Rest API

Clients

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

PreviousClient TagsNextContact Tags

Last updated 7 months ago

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.

Search clients based on parameters

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

E.g. 5tw9zcQkbu

get
Query parameters
limitstringOptional
primaryLocationIdstringOptional
tagsstringOptional
endDatestringOptional
pagestringOptional
startDatestringOptional
searchTextstringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/clients HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "fullName": "text",
    "contactType": "HOME",
    "countryCode": "text",
    "phone": "text",
    "email": "text",
    "registrationDate": "text",
    "dob": "text",
    "addressType": "HOME",
    "address": "text",
    "gender": "Male",
    "maritalStatus": "UNMARRIED",
    "tags": [
      "text"
    ],
    "notes": "text",
    "referralSource": "text",
    "primaryLocation": {
      "id": "text",
      "title": "text"
    },
    "primaryStaff": {
      "id": "text"
    },
    "customFields": {},
    "photo": "https://example.com",
    "emergencyRelationType": "text",
    "emergencyName": "text",
    "emergencyCountryCode": "text",
    "identificationNumber": "text",
    "emergencyPhone": "text"
  }
]
post
Path parameters
clientIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
post
POST /v1/clients/{clientId}/tags/add HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "tags": [
    "text"
  ]
}
post
Path parameters
clientIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
post
POST /v1/clients/{clientId}/tags/remove HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "tags": [
    "text"
  ]
}
get

Gets a Client by Id

Path parameters
clientIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}
delete

Deletes a client based on clientId

Path parameters
clientIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
delete
DELETE /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "success": true
}
  • POST/v1/clients
  • GET/v1/clients
  • GET/v1/clients/{clientId}
  • PUT/v1/clients/{clientId}
  • DELETE/v1/clients/{clientId}
  • POST/v1/clients/{clientId}/tags/add
  • POST/v1/clients/{clientId}/tags/remove
post

Creates a new client based on parameters

Header parameters
x-api-keystringOptional
Body
idstringOptional
fullNamestringRequired
contactTypestring · enumOptionalPossible values:
countryCodestringRequired
phonestringRequired
emailstringOptional
registrationDatestringOptional
dobstringOptional
addressTypestring · enumOptionalPossible values:
addressstringOptional
genderstring · enumOptionalPossible values:
maritalStatusstring · enumOptionalPossible values:
tagsstring[]Optional
notesstringOptional
referralSourcestringOptional
customFieldsobjectOptional
photoUrlstring · uriOptional
emergencyRelationTypestringOptional
emergencyNamestringOptional
emergencyCountryCodestringOptional
identificationNumberstringOptional
emergencyPhonestringOptional
Responses
200
200 response
application/json
post
POST /v1/clients HTTP/1.1
Host: <YOUR HOST>
Content-Type: application/json
Accept: */*
Content-Length: 544

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photoUrl": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}
200

200 response

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}
put

Updates a particular client

Path parameters
clientIdstringRequired
Header parameters
x-api-keystringRequired
Body
idstringOptional
fullNamestringRequired
contactTypestring · enumOptionalPossible values:
countryCodestringRequired
phonestringRequired
emailstringOptional
registrationDatestringOptional
dobstringOptional
addressTypestring · enumOptionalPossible values:
addressstringOptional
genderstring · enumOptionalPossible values:
maritalStatusstring · enumOptionalPossible values:
tagsstring[]Optional
notesstringOptional
referralSourcestringOptional
customFieldsobjectOptional
photoUrlstring · uriOptional
emergencyRelationTypestringOptional
emergencyNamestringOptional
emergencyCountryCodestringOptional
identificationNumberstringOptional
emergencyPhonestringOptional
Responses
200
200 response
application/json
put
PUT /v1/clients/{clientId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 544

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photoUrl": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}
200

200 response

{
  "id": "text",
  "fullName": "text",
  "contactType": "HOME",
  "countryCode": "text",
  "phone": "text",
  "email": "text",
  "registrationDate": "text",
  "dob": "text",
  "addressType": "HOME",
  "address": "text",
  "gender": "Male",
  "maritalStatus": "UNMARRIED",
  "tags": [
    "text"
  ],
  "notes": "text",
  "referralSource": "text",
  "primaryLocation": {
    "id": "text",
    "title": "text"
  },
  "primaryStaff": {
    "id": "text"
  },
  "customFields": {},
  "photo": "https://example.com",
  "emergencyRelationType": "text",
  "emergencyName": "text",
  "emergencyCountryCode": "text",
  "identificationNumber": "text",
  "emergencyPhone": "text"
}