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

Services

This API documentation outlines the functionalities for managing services within Whautomate. It follows the CRUD (Create, Read, Update, Delete) paradigm, enabling you to perform the following actions

PreviousService CategoriesNextAppointments

Last updated 1 year ago

This API offers functionalities to:

  • Creating new services: Establish new service entries, defining their names, descriptions, pricing structures, and associating them with relevant categories.

  • Accessing service information: Retrieve details of all available services or a specific service by its unique identifier.

  • Updating service details: Modify existing services to keep information accurate and reflect any changes. This might involve updating names, descriptions, pricing, or category associations.

  • Removing services: Permanently delete services that are no longer offered, ensuring a clean and up-to-date service catalogue.

get
Query parameters
locationIdstringOptional
limitstringOptional
pagestringOptional
serviceTypestringOptional
searchTextstringOptional
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/services HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

[
  {
    "id": "text",
    "serviceType": "APPOINTMENT",
    "name": "text",
    "location": {
      "id": "text",
      "title": "text"
    },
    "durationMinutes": 1,
    "categories": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "staffs": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "numberOfParticipants": 1,
    "type": "LOCATION_VISIT",
    "sellingPrice": 1,
    "costPrice": 1,
    "taxOverrides": [
      {
        "id": "text",
        "name": "text",
        "percentage": "text"
      }
    ],
    "isCustomCredit": true,
    "credits": 1,
    "active": true,
    "allowOnlineBooking": true,
    "acceptPaymentOnline": true,
    "advanceSettings": {
      "advanceBookingLimitDays": 1,
      "blockTimeAfterAppointment": 1
    },
    "addOnAppliesTo": "SELECTED_SERVICES",
    "addOnServices": [
      {
        "id": "text",
        "name": "text"
      }
    ],
    "sortOrder": 1
  }
]
get
Path parameters
serviceIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
get
GET /v1/services/{serviceId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "serviceType": "APPOINTMENT",
  "name": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "durationMinutes": 1,
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "staffs": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "numberOfParticipants": 1,
  "type": "LOCATION_VISIT",
  "sellingPrice": 1,
  "costPrice": 1,
  "taxOverrides": [
    {
      "id": "text",
      "name": "text",
      "percentage": "text"
    }
  ],
  "isCustomCredit": true,
  "credits": 1,
  "active": true,
  "allowOnlineBooking": true,
  "acceptPaymentOnline": true,
  "advanceSettings": {
    "advanceBookingLimitDays": 1,
    "blockTimeAfterAppointment": 1
  },
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "sortOrder": 1
}
put
Path parameters
serviceIdstringRequired
Header parameters
x-api-keystringRequired
Responses
200
200 response
application/json
put
PUT /v1/services/{serviceId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*
200

200 response

{
  "id": "text",
  "serviceType": "APPOINTMENT",
  "name": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "durationMinutes": 1,
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "staffs": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "numberOfParticipants": 1,
  "type": "LOCATION_VISIT",
  "sellingPrice": 1,
  "costPrice": 1,
  "taxOverrides": [
    {
      "id": "text",
      "name": "text",
      "percentage": "text"
    }
  ],
  "isCustomCredit": true,
  "credits": 1,
  "active": true,
  "allowOnlineBooking": true,
  "acceptPaymentOnline": true,
  "advanceSettings": {
    "advanceBookingLimitDays": 1,
    "blockTimeAfterAppointment": 1
  },
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "sortOrder": 1
}
  • GET/v1/services
  • POST/v1/services
  • GET/v1/services/{serviceId}
  • PUT/v1/services/{serviceId}
post
Header parameters
x-api-keystringRequired
Body
idstringOptional
serviceTypestring · enumRequiredPossible values:
namestringRequired
durationMinutesintegerOptional
numberOfParticipantsnumberOptional
typestring · enumOptionalPossible values:
sellingPricenumberRequired
costPricenumberOptional
isCustomCreditbooleanOptional
creditsintegerOptional
activebooleanOptional
allowOnlineBookingbooleanOptional
acceptPaymentOnlinebooleanOptional
addOnAppliesTostring · enumOptionalPossible values:
sortOrderintegerOptional
Responses
200
200 response
application/json
Responseobject · EmptySchema
post
POST /v1/services HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 618

{
  "id": "text",
  "serviceType": "APPOINTMENT",
  "name": "text",
  "location": {
    "id": "text",
    "title": "text"
  },
  "durationMinutes": 1,
  "categories": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "staffs": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "numberOfParticipants": 1,
  "type": "LOCATION_VISIT",
  "sellingPrice": 1,
  "costPrice": 1,
  "taxOverrides": [
    {
      "id": "text",
      "name": "text",
      "percentage": "text"
    }
  ],
  "isCustomCredit": true,
  "credits": 1,
  "active": true,
  "allowOnlineBooking": true,
  "acceptPaymentOnline": true,
  "advanceSettings": {
    "advanceBookingLimitDays": 1,
    "blockTimeAfterAppointment": 1
  },
  "addOnAppliesTo": "SELECTED_SERVICES",
  "addOnServices": [
    {
      "id": "text",
      "name": "text"
    }
  ],
  "sortOrder": 1
}
200

200 response

{}