Skip to main content

Clients

Clients are the people in your client list (Clients in the app): their contact details, tags, custom fields and the channels they get updates on. Use these endpoints to sync clients with your website, CRM or lead forms.

  • Create or update: POST /v1/clients creates a client, or updates the client with the same full name and phone number. The response says which with created.
  • Partial updates: PUT /v1/clients/{clientId} changes only the fields you send. Send null, "" or [] to clear a field. fullName, countryCode, phone and primaryLocation cannot be cleared.
  • Tags: adding a tag can start automations (for example a welcome sequence). Unknown tags are created.
  • Plan: creating, changing and deleting clients needs the CRM Suite add-on; reading works on every plan.

The {id} in a path is the record id returned by the API (for example 5tw9zcQkbu), not the client number shown in the app.

API regionapi.whautomate.com

Search clients​

GET /v1/clients

Lists clients, newest first. Filter by text, tags, primary location or registration date.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitinteger
Results per page (default 10, max 100).
primaryLocationIdstring
Only clients whose primary location is this location.
tagsstring
Comma separated tag names; matches records with any of them.
endDatestring
Registered on or before this date (YYYY-MM-DD, account timezone).
pageinteger
Page number, from 1 (default 1).
startDatestring
Registered on or after this date (YYYY-MM-DD, account timezone).
searchTextstring
Matches full name, client number, identification number or phone. Start with + to search a full international number.
Response 200
idstring
createdboolean
POST /v1/clients (and its bulk items): false when the client with the same externalId, or the same name and phone, was updated.
externalIdstring
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
notificationChannelsstring[]
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
taxIdTypestring
taxIdNumberstring
clientIdstring
Client number shown in the app (not the record id).
preferredLanguagestring
Preferred language name.
createdAtstring
When the record was created (ISO 8601, UTC).
updatedAtstring
When the record was last changed (ISO 8601, UTC).
Request
curl -X GET "https://api.whautomate.com/v1/clients?searchText=Olivia&limit=2" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "Rkb6qfbG8F",
    "clientId": "C2",
    "fullName": "Olivia Tan",
    "contactType": "MOBILE",
    "countryCode": "+65",
    "phone": "91203457",
    "email": "olivia.tan@mail.example",
    "registrationDate": "2026-10-29T11:42:19.185Z",
    "dob": "1974-12-31T16:00:00.000Z",
    "gender": "Female",
    "preferredLanguage": "",
    "tags": [
      "VIP",
      "Member"
    ],
    "notificationChannels": [],
    "referralSource": "Instagram",
    "primaryLocation": {
      "id": "Le6dWjQF9K",
      "title": "Serene Wellness Studio"
    },
    "customFields": {
      "Preferred therapist": "Aisha",
      "Pressure preference": "Firm"
    },
    "createdAt": "2026-10-29T11:42:19.276Z",
    "updatedAt": "2026-10-29T11:42:19.346Z"
  }
]

Get a client​

GET /v1/clients/{clientId}

Gets one client by id.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Client id.
Response 200
idstring
createdboolean
POST /v1/clients (and its bulk items): false when the client with the same externalId, or the same name and phone, was updated.
externalIdstring
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
notificationChannelsstring[]
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
taxIdTypestring
taxIdNumberstring
clientIdstring
Client number shown in the app (not the record id).
preferredLanguagestring
Preferred language name.
createdAtstring
When the record was created (ISO 8601, UTC).
updatedAtstring
When the record was last changed (ISO 8601, UTC).
Request
curl -X GET "https://api.whautomate.com/v1/clients/Rkb6qfbG8F" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "Rkb6qfbG8F",
  "clientId": "C2",
  "fullName": "Olivia Tan",
  "contactType": "MOBILE",
  "countryCode": "+65",
  "phone": "91203457",
  "email": "olivia.tan@mail.example",
  "registrationDate": "2026-10-29T11:42:19.185Z",
  "dob": "1974-12-31T16:00:00.000Z",
  "gender": "Female",
  "preferredLanguage": "",
  "tags": [
    "VIP",
    "Member"
  ],
  "notificationChannels": [],
  "referralSource": "Instagram",
  "primaryLocation": {
    "id": "Le6dWjQF9K",
    "title": "Serene Wellness Studio"
  },
  "customFields": {
    "Preferred therapist": "Aisha",
    "Pressure preference": "Firm"
  },
  "createdAt": "2026-10-29T11:42:19.276Z",
  "updatedAt": "2026-10-29T11:42:19.346Z"
}

Create or update a client​

POST /v1/clients

Creates a client. When a client with the same externalId exists, or else one with the same full name and phone number, that client is updated instead (only the fields you send change) and created is false.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
externalIdstring
Your own id for the client (from your system), unique in the account. Left out keeps it; null or an empty value clears it.
fullNamestringrequired
Full name.
countryCodestringrequired
Dialling code, for example +65.
phonestringrequired
Phone number without the country code.
contactTypestring
Left out keeps the stored value; null or an empty value clears it.
emailstring
Left out keeps the stored value; null or an empty value clears it.
registrationDatestring
Left out keeps the stored value; null or an empty value clears it.
dobstring
Left out keeps the stored value; null or an empty value clears it.
addressTypestring
Left out keeps the stored value; null or an empty value clears it.
addressstring
Left out keeps the stored value; null or an empty value clears it.
genderstring
Left out keeps the stored value; null or an empty value clears it.
maritalStatusstring
Left out keeps the stored value; null or an empty value clears it.
tagsstring[]
Tag names; replace the stored tags. Left out keeps them; null or [] removes them all.
notesstring
Left out keeps the stored value; null or an empty value clears it.
referralSourcestring
Left out keeps the stored value; null or an empty value clears it.
notificationChannelsstring[]
List of whatsapp, telegram, sms, email: channels the client chose to receive updates on. Left out keeps them; null or [] clears them.
primaryLocationobject

Location the client belongs to: { id }. Defaults to your first location.

primaryStaffobject
{ id }. Left out keeps it; null clears it.
customFieldsobject
Object of values; replaces the stored values. Left out keeps them; null clears them.
photoUrlobject
Left out keeps the stored value; null or an empty value clears it.
emergencyRelationTypestring
Left out keeps the stored value; null or an empty value clears it.
emergencyNamestring
Left out keeps the stored value; null or an empty value clears it.
emergencyCountryCodestring
Left out keeps the stored value; null or an empty value clears it.
identificationNumberstring
Left out keeps the stored value; null or an empty value clears it.
emergencyPhonestring
Left out keeps the stored value; null or an empty value clears it.
companystring
Left out keeps the stored value; null or an empty value clears it.
taxIdTypestring
Left out keeps the stored value; null or an empty value clears it.
taxIdNumberstring
Left out keeps the stored value; null or an empty value clears it.
preferredNamestring
Name the client likes to be called.
Response 200
idstring
createdboolean
POST /v1/clients (and its bulk items): false when the client with the same externalId, or the same name and phone, was updated.
externalIdstring
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
notificationChannelsstring[]
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
taxIdTypestring
taxIdNumberstring
clientIdstring
Client number shown in the app (not the record id).
preferredLanguagestring
Preferred language name.
createdAtstring
When the record was created (ISO 8601, UTC).
updatedAtstring
When the record was last changed (ISO 8601, UTC).
Errors
StatusErrorMeaning
400Invalid parametersfullName, countryCode or phone is missing, or a field has the wrong format.
403This feature is not included in your plan.Needs the CRM Suite add-on.
404Invalid Primary locationIdThe location is not in your account.
Request: Create a client
curl -X POST "https://api.whautomate.com/v1/clients" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "Priya Nair",
    "countryCode": "+65",
    "phone": "96628413",
    "email": "priya.nair@example.com",
    "tags": [
      "New",
      "Massage"
    ],
    "referralSource": "Instagram",
    "notes": "Prefers weekday evenings.",
    "primaryLocation": {
      "id": "Le6dWjQF9K"
    }
  }'
Response 200: Create a client
{
  "id": "FLT22gHGml",
  "clientId": "C90",
  "fullName": "Priya Nair",
  "countryCode": "+65",
  "phone": "96628413",
  "email": "priya.nair@example.com",
  "registrationDate": "2026-10-29T12:40:10.070Z",
  "gender": "",
  "preferredLanguage": "",
  "tags": [
    "New",
    "Massage"
  ],
  "notificationChannels": [],
  "notes": "Prefers weekday evenings.",
  "referralSource": "Instagram",
  "primaryLocation": {
    "id": "Le6dWjQF9K",
    "title": "Serene Wellness Studio"
  },
  "createdAt": "2026-10-29T12:40:10.076Z",
  "updatedAt": "2026-10-29T12:40:10.076Z",
  "created": true
}
Request: Same name and phone: the client is updated (created false)
curl -X POST "https://api.whautomate.com/v1/clients" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "Priya Nair",
    "countryCode": "+65",
    "phone": "96628413",
    "company": "Nair Design Studio"
  }'
Response 200: Same name and phone: the client is updated (created false)
{
  "id": "FLT22gHGml",
  "clientId": "C90",
  "fullName": "Priya Nair",
  "countryCode": "+65",
  "phone": "96628413",
  "email": "priya.nair@example.com",
  "registrationDate": "2026-10-29T12:40:10.070Z",
  "gender": "",
  "preferredLanguage": "",
  "tags": [
    "New",
    "Massage"
  ],
  "notificationChannels": [],
  "notes": "Prefers weekday evenings.",
  "referralSource": "Instagram",
  "primaryLocation": {
    "id": "Le6dWjQF9K"
  },
  "company": "Nair Design Studio",
  "createdAt": "2026-10-29T12:40:10.076Z",
  "updatedAt": "2026-10-29T12:40:10.180Z",
  "created": false
}
Response 400: Phone missing
{
  "error": "Invalid parameters, Name, countryCode & phone are mandatory!"
}

Update a client​

PUT /v1/clients/{clientId}

Updates a client. Only the fields you send change; null, "" or [] clears a field. fullName, countryCode, phone and primaryLocation cannot be cleared (400).

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
clientIdstringrequired
Client id.
Body
externalIdstring
Your own id for the client (from your system), unique in the account. Left out keeps it; null or an empty value clears it.
fullNamestring
Cannot be cleared.
countryCodestring
Dialling code, e.g. +65. Cannot be cleared.
phonestring
Without the country code. Cannot be cleared.
contactTypestring
Left out keeps the stored value; null or an empty value clears it.
emailstring
Left out keeps the stored value; null or an empty value clears it.
registrationDatestring
Left out keeps the stored value; null or an empty value clears it.
dobstring
Left out keeps the stored value; null or an empty value clears it.
addressTypestring
Left out keeps the stored value; null or an empty value clears it.
addressstring
Left out keeps the stored value; null or an empty value clears it.
genderstring
Left out keeps the stored value; null or an empty value clears it.
maritalStatusstring
Left out keeps the stored value; null or an empty value clears it.
tagsstring[]
Tag names; replace the stored tags. Left out keeps them; null or [] removes them all.
notesstring
Left out keeps the stored value; null or an empty value clears it.
referralSourcestring
Left out keeps the stored value; null or an empty value clears it.
notificationChannelsstring[]
List of whatsapp, telegram, sms, email: channels the client chose to receive updates on. Left out keeps them; null or [] clears them.
primaryLocationobject

{ id } of a location of the account. Left out keeps it; it cannot be cleared (null or an empty value is refused with 400).

primaryStaffobject
{ id }. Left out keeps it; null clears it.
customFieldsobject
Object of values; replaces the stored values. Left out keeps them; null clears them.
photoUrlobject
Left out keeps the stored value; null or an empty value clears it.
emergencyRelationTypestring
Left out keeps the stored value; null or an empty value clears it.
emergencyNamestring
Left out keeps the stored value; null or an empty value clears it.
emergencyCountryCodestring
Left out keeps the stored value; null or an empty value clears it.
identificationNumberstring
Left out keeps the stored value; null or an empty value clears it.
emergencyPhonestring
Left out keeps the stored value; null or an empty value clears it.
companystring
Left out keeps the stored value; null or an empty value clears it.
taxIdTypestring
Left out keeps the stored value; null or an empty value clears it.
taxIdNumberstring
Left out keeps the stored value; null or an empty value clears it.
preferredNamestring
Name the client likes to be called. Left out keeps the stored value; null or an empty value clears it.
Response 200
idstring
createdboolean
POST /v1/clients (and its bulk items): false when the client with the same externalId, or the same name and phone, was updated.
externalIdstring
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
notificationChannelsstring[]
primaryLocationobject
primaryStaffobject
customFieldsobject
photostring
emergencyRelationTypestring
emergencyNamestring
emergencyCountryCodestring
identificationNumberstring
emergencyPhonestring
companystring
taxIdTypestring
taxIdNumberstring
clientIdstring
Client number shown in the app (not the record id).
preferredLanguagestring
Preferred language name.
createdAtstring
When the record was created (ISO 8601, UTC).
updatedAtstring
When the record was last changed (ISO 8601, UTC).
Request
curl -X PUT "https://api.whautomate.com/v1/clients/FLT22gHGml" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "priya@nairdesign.example.com",
    "notes": "Prefers weekday evenings. Mild lower back pain."
  }'
Response 200
{
  "id": "FLT22gHGml",
  "clientId": "C90",
  "fullName": "Priya Nair",
  "countryCode": "+65",
  "phone": "96628413",
  "email": "priya@nairdesign.example.com",
  "registrationDate": "2026-10-29T12:40:10.070Z",
  "gender": "",
  "preferredLanguage": "",
  "tags": [
    "New",
    "Massage"
  ],
  "notificationChannels": [],
  "notes": "Prefers weekday evenings. Mild lower back pain.",
  "referralSource": "Instagram",
  "primaryLocation": {
    "id": "Le6dWjQF9K"
  },
  "company": "Nair Design Studio",
  "createdAt": "2026-10-29T12:40:10.076Z",
  "updatedAt": "2026-10-29T12:40:10.294Z"
}

Delete a client​

DEL /v1/clients/{clientId}

Deletes a client.

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

Add tags to a client​

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

Adds tags to a client. Unknown tags are created. Adding a tag can start automations that use the tag added trigger.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
tagsstring[]required
Tag names. Unknown tags are created.
Response 200
idstring
tagsstring[]
The tags on the record after the change.
Request
curl -X POST "https://api.whautomate.com/v1/clients/FLT22gHGml/tags/add" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": [
      "VIP",
      "Prenatal"
    ]
  }'
Response 200
{
  "id": "FLT22gHGml",
  "tags": [
    "New",
    "Massage",
    "VIP"
  ]
}

Remove tags from a client​

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

Removes tags from a client.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
tagsstring[]required
Tag names. Unknown tags are created.
Response 200
idstring
tagsstring[]
The tags on the record after the change.
Request
curl -X POST "https://api.whautomate.com/v1/clients/FLT22gHGml/tags/remove" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": [
      "New"
    ]
  }'
Response 200
{
  "id": "FLT22gHGml",
  "tags": [
    "Massage",
    "VIP"
  ]
}

Bulk​

Bulk endpoints take up to 100 items and run each one through the single endpoint (same checks and plan limits). They answer 200 with a result per item, so check failed. Bulk calls run no automations; webhooks still fire.

Create or update clients in bulk​

POST /v1/clients/bulk

Creates clients, or updates the client with the same externalId, else the same full name and phone (partial; each result data has created true or false). Up to 100 items, run one by one through the single route (same validation and plan limits, per item deactivated location check). Bulk runs no automations; webhooks still fire.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
itemsobject[]required

Up to 100 client create bodies, the same as POST /v1/clients

Response 200
succeededinteger
failedinteger
resultsobject[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/bulk" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "fullName": "Daniel Wong",
        "countryCode": "+65",
        "phone": "97745102",
        "email": "daniel.wong@example.com",
        "tags": [
          "Corporate"
        ],
        "primaryLocation": {
          "id": "Le6dWjQF9K"
        }
      },
      {
        "fullName": "Mei Lin Ho",
        "countryCode": "+65",
        "email": "meilin.ho@example.com"
      }
    ]
  }'
Response 200
{
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "data": {
        "id": "iqf8hDweF6",
        "clientId": "C91",
        "fullName": "Daniel Wong",
        "countryCode": "+65",
        "phone": "97745102",
        "email": "daniel.wong@example.com",
        "registrationDate": "2026-10-29T12:40:10.565Z",
        "gender": "",
        "preferredLanguage": "",
        "tags": [
          "Corporate"
        ],
        "notificationChannels": [],
        "primaryLocation": {
          "id": "Le6dWjQF9K",
          "title": "Serene Wellness Studio"
        },
        "createdAt": "2026-10-29T12:40:10.570Z",
        "updatedAt": "2026-10-29T12:40:10.570Z",
        "created": true
      }
    },
    {
      "index": 1,
      "ok": false,
      "status": 400,
      "error": "Invalid parameters, Name, countryCode & phone are mandatory!"
    }
  ]
}

Update clients in bulk​

POST /v1/clients/bulk/update

Updates clients partially (as PUT /v1/clients/{clientId}); every item needs id. Up to 100 items, run one by one through the single route (same validation and plan limits, per item deactivated location check). Bulk runs no automations; webhooks still fire.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
itemsobject[]required

Up to 100 update bodies, the same as PUT /v1/clients/{clientId}, each with the record id

Response 200
succeededinteger
failedinteger
resultsobject[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/bulk/update" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "id": "iqf8hDweF6",
        "company": "Harbourfront Capital"
      },
      {
        "id": "doesNotExist1",
        "notes": "Moved to Penang"
      }
    ]
  }'
Response 200
{
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "data": {
        "id": "iqf8hDweF6",
        "clientId": "C91",
        "fullName": "Daniel Wong",
        "countryCode": "+65",
        "phone": "97745102",
        "email": "daniel.wong@example.com",
        "registrationDate": "2026-10-29T12:40:10.565Z",
        "gender": "",
        "preferredLanguage": "",
        "tags": [
          "Corporate"
        ],
        "notificationChannels": [],
        "primaryLocation": {
          "id": "Le6dWjQF9K"
        },
        "company": "Harbourfront Capital",
        "createdAt": "2026-10-29T12:40:10.570Z",
        "updatedAt": "2026-10-29T12:40:10.690Z"
      }
    },
    {
      "index": 1,
      "ok": false,
      "status": 404,
      "error": "Client not found"
    }
  ]
}

Delete clients in bulk​

POST /v1/clients/bulk/delete

Deletes clients by clientIds. Up to 100 items, run one by one through the single route (same validation and plan limits, per item deactivated location check). Bulk runs no automations; webhooks still fire.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
clientIdsstring[]required
Up to 100
Response 200
succeededinteger
failedinteger
resultsobject[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/bulk/delete" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientIds": [
      "iqf8hDweF6",
      "doesNotExist1"
    ]
  }'
Response 200
{
  "succeeded": 1,
  "failed": 1,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "data": {
        "success": true
      }
    },
    {
      "index": 1,
      "ok": false,
      "status": 404,
      "error": "Client not found"
    }
  ]
}

Add tags to clients in bulk​

POST /v1/clients/bulk/add-tags

Adds tags to clients. Up to 100 items, run one by one through the single route (same validation and plan limits, per item deactivated location check). Bulk runs no automations; webhooks still fire.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
clientIdsstring[]required
Up to 100
tagsstring[]required
Tag names
Response 200
succeededinteger
failedinteger
resultsobject[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/bulk/add-tags" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientIds": [
      "iqf8hDweF6",
      "FLT22gHGml"
    ],
    "tags": [
      "Corporate wellness"
    ]
  }'
Response 200
{
  "succeeded": 2,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "data": {
        "id": "iqf8hDweF6",
        "tags": [
          "Corporate",
          "Corporate wellness"
        ]
      }
    },
    {
      "index": 1,
      "ok": true,
      "status": 200,
      "data": {
        "id": "FLT22gHGml",
        "tags": [
          "Massage",
          "VIP",
          "Prenatal"
        ]
      }
    }
  ]
}

Remove tags from clients in bulk​

POST /v1/clients/bulk/remove-tags

Removes tags from clients. Up to 100 items, run one by one through the single route (same validation and plan limits, per item deactivated location check). Bulk runs no automations; webhooks still fire.

Headers
x-api-keystringrequired
Your Whautomate API key.
Body
clientIdsstring[]required
Up to 100
tagsstring[]required
Tag names
Response 200
succeededinteger
failedinteger
resultsobject[]
Request
curl -X POST "https://api.whautomate.com/v1/clients/bulk/remove-tags" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientIds": [
      "iqf8hDweF6",
      "FLT22gHGml"
    ],
    "tags": [
      "Corporate wellness"
    ]
  }'
Response 200
{
  "succeeded": 2,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "data": {
        "id": "iqf8hDweF6",
        "tags": [
          "Corporate"
        ]
      }
    },
    {
      "index": 1,
      "ok": true,
      "status": 200,
      "data": {
        "id": "FLT22gHGml",
        "tags": [
          "Massage",
          "VIP"
        ]
      }
    }
  ]
}
Last updated on