Remove members from a group

Remove customers from a broadcast group by phone number.

Before you call

  • groupId is required.
  • phoneNumbers is a non-empty list of valid phone numbers with country code.
  • You need permission to remove members from that group.

How it works

  • The response has two lists: success (removed) and failed.
  • A number lands in failed if no customer has it, it is not in the group, or the removal failed.
  • Duplicate numbers in the request are removed once.
  • The customers themselves are not deleted.

Rate limit

  • 60 requests per minute.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The ID of the group to remove members from

phoneNumbers
array of strings
required
length ≥ 1

List of phone numbers to remove from the group

phoneNumbers*
Responses

400

Bad request, invalid input provided

401

Invalid or missing API key

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json