Users
Delete a user
Permanently deletes a user from your organization.
Important Restrictions:
- Cannot delete users with active phone numbers (must terminate user plan first)
- Cannot delete admin users
- Cannot delete yourself
Before deleting, ensure the user's local number is in SUSPENDED, DEACTIVATED state, or doesn't exist.
delete/v1/users/{userId}
Request
- Base URLhttps://api.telgea.com
- AuthAPI key in header x-api-key
Path parameters
userIdstring uuid required
UUID of the user.
Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01
Headers
idempotency-keystring
A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.
Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60
Response
User deleted successfully. No content returned.
Changes
No recorded changes to this operation across all 1 revision of this API.