API Reference
  1. Lodgestory WhatsApp CRM API
  2. Segments

Remove Segment Members

post
https://api.lodgestory.com/api/wp-crm/segments///members/remove

Remove up to 1,000 people by member id, phone or email.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

string
required

A segment id (segmentId from the list or create response).

Body Params
memberIds
array of strings

Member ids (from the members list).

memberIds
phones
array of strings

Phone numbers (E.164 preferred).

phones
emails
array of strings

Email addresses.

emails
Responses
200

{ removed, memberCount }

400

Nothing to remove, or more than 1,000

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

404

Segment not found in your organisation

429

Too many requests

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 2 hours ago

Did this page help you?