Delete or archive a user
Permanently deletes or archives a user by their unique identifier. The type query parameter controls whether the user is fully deleted (DELETED) or archived (ARCHIVED). Deleting a user removes their account, numbers, and all associated resources. Archiving a user disables their account but preserves their data for future reactivation.
Permission: No specific permission required. A valid API key is sufficient.
Monitoring: Not needed.
Warning — Destructive operation: This route does not enforce any specific permission category. Any valid API key can delete or archive any user in the team. Exercise extreme caution when using this endpoint, especially in automated workflows. Consider restricting API key distribution accordingly.
Path parameters
The identifier of the user
Query parameters
Type of deletion
Response
Successful operation