Whautomate Rest API

We are launching our first version of Whautomate Rest APIs for external integrations with other applications.

General Use Cases:

  • Add Clients from External Systems through API

  • Sync Clients from External Systems through API

  • Add Client to tags to segment clients and trigger automations to send messages

  • Remove Client from tags to segment clients and trigger automations to send messages

  • Add Contacts from External Systems through API

  • Add Contacts to Segments by adding Tags and triggering automations to send messages, etc.

  • Update Contact Stage based on events to manage Sales funnel

  • Remove Contacts from Tags to segment and trigger automations

  • Manage Custom Fields of Clients/Contacts

  • Manage Customer Segmentation via API and run targeted campaigns

  • Trigger Broadcasts via API

  • View Staffs and block staff's time from external applications through API

  • Create and update Services through API

  • Book, Reschedule and Cancel Appointments through API

  • Create, Update and Delete Classes through API

  • Add and Remove Participants from a Class through API

API Host:

For seamless integration with Whautomate's services, use the appropriate API host based on your geographical location:

Global: https://api.whautomate.com

India: https://api.in.whautomate.com

To determine the correct API host, visit the 'Rest API' section under 'Integrations' in your Whautomate account and copy your host name. Use the relevant hostname for your region when making API calls for optimal performance.

API Key Authentication with x-api-key Header

Authentication is vital when accessing Whautomate's APIs to ensure secure and authorized interactions. To authenticate your API requests, Whautomate utilizes API keys. These keys act as unique identifiers, granting access to the platform's functionalities.

Follow these steps to authenticate using your generated API key:

Generating the API Key: Access your Whautomate account and navigate to the Integrations-> REST API settings to generate an API key. This key serves as your credential for API authentication.

Adding API Key to the Header: When making API requests, include the API key in the header of your HTTP requests. Specifically, append the API key to the x-api-key header parameter.

Example:

curl -X GET 'https://api.whautomate.com/some_endpoint' -H 'x-api-key: YOUR_API_KEY'

Rate Limits

At Whautomate, we prioritize fairness, stability, and security in our platform. That's why we implement rate limits on our API for every account. These limits ensure fair usage for all users and protect against system abuse.

Why do we have Rate Limits?

To ensure fairness: Rate limits make sure that everyone using our platform has an equal chance to access its resources, preventing any one user from taking over.

For system stability: By managing the flow of traffic, rate limits keep our system running smoothly, reducing the chances of it crashing or slowing down.

To enhance security: Rate limits act as a shield against malicious attacks, like DDoS, by putting a cap on how many requests can be made, preventing any one user from overwhelming the system.

For enterprise customers needing higher limits, contact us for assistance. Additional pricing may apply.

Type of AccountRequests per minute (RPM)Requests per day (RPD)

Trial Account

60

100

Subscribed Account

300

432,000

Get Started

Step 1: Go to the Integrations page in the Whautomate platform then scroll down and select the REST API connect button to continue.

Step 2: To copy Your API Host URL, simply click on the "Copy" button.

Step 3: Select the New API Key button, Enter a key name (e.g. Whautomate API) and Select the Generate button to get the API Key.

Step 4: Your Whautomate API key has been generated successfully just copy and use it.

How to test Whautomate Rest API in Postman

Step 1: Please download the setup files for the Whautomate REST API Postman Collection. 👇

Step 2: (i) Open the Postman app, select the Import button, and drag and drop the Whautomate REST API Postman Collection files. ☝

(ii) Select the Import button to continue.

Step 3: Select the Environments menu, Choose the Whautomate Rest API option to continue.

(i) Paste the API host URL in the host - CURRENT VALUE field.

Use the appropriate API host based on your geographical location:

Global: https://api.whautomate.com

India: https://api.in.whautomate.com

(ii) Paste the Whautomate-generated API Key in the x-api-key - CURRENT VALUE field.

(iii) Once done select the Save option to connect the Whautomate Rest API successfully.

Step 4: Select the Collections menu and Choose the Whautomate Rest API option to access the following API endpoints

  • Clients

  • Client Tags

  • Contacts

  • Contact Tags

  • Staffs

  • Locations

  • Segments

  • Broadcasts

  • Messages

  • Service Categories

  • Services

  • Appointments

  • Classes

Here are the articles in this section:

pageClient TagspageClientspageContact TagspageContactspageLocationspageStaffspageSegmentspageBroadcastspageMessagespageService CategoriespageServicespageAppointmentspageClasses

Last updated