Actions31
- Auth Actions
- Car Actions
- Dashboard Actions
- Device Actions
- Organization Actions
- Place Actions
- User Actions
User → Delete
AI-generatedSummary
Deletes one or more users from a specific place using the PAL Gate API.
Inputs
- placeId (required) — The ID of the place from which users should be deleted.
- phone (required) — Phone number(s) to delete. The input is sanitized (whitespace, parentheses, dashes removed), prefixed with 972 if needed, and sent as an array in the request body. Empty input throws an error to prevent accidental deletion of all users.
- requestOptions — Options for configuring the HTTP request, including batching, SSL settings, proxy, and timeout.
Output shape
The API response body for the delete request.
The operation returns the raw response from the POST /place/{placeId}/delete-many-users endpoint.
Examples
Example 1: Delete a single user by phone number.
Place ID: 123, Phone: 972501234567
Example 2: Delete multiple users by providing a list of phone numbers.
Place ID: 123, Phone: [972501234567, 972501234568]